From: <ega...@us...> - 2011-02-13 21:54:24
|
Revision: 142 http://nagios.svn.sourceforge.net/nagios/?rev=142&view=rev Author: egalstad Date: 2011-02-13 21:54:15 +0000 (Sun, 13 Feb 2011) Log Message: ----------- Documentation moved online Modified Paths: -------------- nagioscore/trunk/Changelog Removed Paths: ------------- nagioscore/trunk/html/docs/about.html nagioscore/trunk/html/docs/activechecks.html nagioscore/trunk/html/docs/adaptive.html nagioscore/trunk/html/docs/addons.html nagioscore/trunk/html/docs/beginners.html nagioscore/trunk/html/docs/cachedchecks.html nagioscore/trunk/html/docs/cgiauth.html nagioscore/trunk/html/docs/cgiincludes.html nagioscore/trunk/html/docs/cgis.html nagioscore/trunk/html/docs/cgisecurity.html nagioscore/trunk/html/docs/checkscheduling.html nagioscore/trunk/html/docs/clusters.html nagioscore/trunk/html/docs/config.html nagioscore/trunk/html/docs/configcgi.html nagioscore/trunk/html/docs/configmain.html nagioscore/trunk/html/docs/configobject.html nagioscore/trunk/html/docs/customobjectvars.html nagioscore/trunk/html/docs/dependencies.html nagioscore/trunk/html/docs/dependencychecks.html nagioscore/trunk/html/docs/distributed.html nagioscore/trunk/html/docs/downtime.html nagioscore/trunk/html/docs/embeddedperl.html nagioscore/trunk/html/docs/epnplugins.html nagioscore/trunk/html/docs/escalations.html nagioscore/trunk/html/docs/eventhandlers.html nagioscore/trunk/html/docs/extcommands.html nagioscore/trunk/html/docs/faststartup.html nagioscore/trunk/html/docs/flapping.html nagioscore/trunk/html/docs/freshness.html nagioscore/trunk/html/docs/funstuff.html nagioscore/trunk/html/docs/hostchecks.html nagioscore/trunk/html/docs/images/ nagioscore/trunk/html/docs/int-snmptrap.html nagioscore/trunk/html/docs/int-tcpwrappers.html nagioscore/trunk/html/docs/integration.html nagioscore/trunk/html/docs/knownissues.html nagioscore/trunk/html/docs/largeinstalltweaks.html nagioscore/trunk/html/docs/macrolist.html nagioscore/trunk/html/docs/macros.html nagioscore/trunk/html/docs/monitoring-linux.html nagioscore/trunk/html/docs/monitoring-netware.html nagioscore/trunk/html/docs/monitoring-printers.html nagioscore/trunk/html/docs/monitoring-publicservices.html nagioscore/trunk/html/docs/monitoring-routers.html nagioscore/trunk/html/docs/monitoring-windows.html nagioscore/trunk/html/docs/mrtggraphs.html nagioscore/trunk/html/docs/nagiostats.html nagioscore/trunk/html/docs/networkreachability.html nagioscore/trunk/html/docs/notifications.html nagioscore/trunk/html/docs/objectdefinitions.html nagioscore/trunk/html/docs/objectinheritance.html nagioscore/trunk/html/docs/objecttricks.html nagioscore/trunk/html/docs/oncallrotation.html nagioscore/trunk/html/docs/passivechecks.html nagioscore/trunk/html/docs/passivestatetranslation.html nagioscore/trunk/html/docs/perfdata.html nagioscore/trunk/html/docs/pluginapi.html nagioscore/trunk/html/docs/plugins.html nagioscore/trunk/html/docs/quickstart-fedora.html nagioscore/trunk/html/docs/quickstart-opensuse.html nagioscore/trunk/html/docs/quickstart-ubuntu.html nagioscore/trunk/html/docs/quickstart.html nagioscore/trunk/html/docs/redundancy.html nagioscore/trunk/html/docs/robots.txt nagioscore/trunk/html/docs/security.html nagioscore/trunk/html/docs/servicechecks.html nagioscore/trunk/html/docs/stalking.html nagioscore/trunk/html/docs/startstop.html nagioscore/trunk/html/docs/statetypes.html nagioscore/trunk/html/docs/timeperiods.html nagioscore/trunk/html/docs/toc.html nagioscore/trunk/html/docs/tuning.html nagioscore/trunk/html/docs/upgrading.html nagioscore/trunk/html/docs/verifyconfig.html nagioscore/trunk/html/docs/volatileservices.html nagioscore/trunk/html/docs/whatsnew.html Modified: nagioscore/trunk/Changelog =================================================================== --- nagioscore/trunk/Changelog 2011-02-13 21:50:59 UTC (rev 141) +++ nagioscore/trunk/Changelog 2011-02-13 21:54:15 UTC (rev 142) @@ -7,6 +7,7 @@ ENHANCEMENTS * Added support for same host service dependencies with servicegroups (Mathieu Gagné) * Empty hostgroups referenced from services now optionally generate a warning instead of an error. +* Documentation links now point to online resources FIXES * Fixes status.cgi when called with no parameters, where host should be set to all if none specified (Michael Friedrich) Deleted: nagioscore/trunk/html/docs/about.html =================================================================== --- nagioscore/trunk/html/docs/about.html 2011-02-13 21:50:59 UTC (rev 141) +++ nagioscore/trunk/html/docs/about.html 2011-02-13 21:54:15 UTC (rev 142) @@ -1,238 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> - - - -<html> - -<head> - -<title>About Nagios Core</title> - - - -<STYLE type="text/css"> - -<!-- - - .Trademark { font-family: verdana,arial,serif; font-size: 7pt; } - - - - .Disclaimer { font-family: verdana,arial,serif; font-size: 7pt; font-style: italic; text-align: center; } - - - - .Default { font-family: verdana,arial,serif; font-size: 8pt; } - - .PageTitle { font-family: verdana,arial,serif; font-size: 16pt; font-weight: bold; } - ---> - -</STYLE> - - - -</head> - - - -<body bgcolor="#FFFFFF" text="black" class="Default"> - - - -<div align="center"> - -<img src="images/nagios.jpg" border="0" alt="Nagios" title="Nagios"> - -<h1 class="PageTitle">About Nagios Core</h1> - -</div> - - - -<hr> - - - -<p> - -<img src="images/upto.gif" border="0" align="middle" alt="Up To" title="Up To">Up To: <a href="toc.html">Contents</a><br> - -<img src="images/seealso.gif" border="0" align="middle" alt="See Also" title="See Also"> See Also: <a href="quickstart.html">Quickstart Installation Guides</a> - -</p> - -<p> - -<a name="overview"></a> - -<strong><u>Nagios Core Overview</u></strong> - -</p> - -<p> -More information about Nagios Core - including features and technical specifications can be found online at <a href="http://www.nagios.org/about/" target="_blank"><b>www.nagios.org/about/</b></a>. -</p> - -<p> - -<a name="whatis"></a> - -<strong><u>What Is Nagios Core?</u></strong> - -</p> - - - -<p> - -Nagios® Core™ is an Open Source system and network monitoring application. It watches hosts and services that you specify, alerting you when things go bad and when they get better. - -</p> - -<p> - -Nagios Core was originally designed to run under <a href="http://www.linux.com">Linux</a>, although it should work under most other unices as well. - -</p> - -<p> - -Some of the many features of Nagios Core include: - -</p> - -<ul> - -<li>Monitoring of network services (SMTP, POP3, HTTP, NNTP, PING, etc.) - -<li>Monitoring of host resources (processor load, disk usage, etc.) - -<li>Simple plugin design that allows users to easily develop their own service checks - -<li>Parallelized service checks - -<li>Ability to define network host hierarchy using "parent" hosts, allowing detection of and distinction between hosts that are down and those that are unreachable - -<li>Contact notifications when service or host problems occur and get resolved (via email, pager, or user-defined method) - -<li>Ability to define event handlers to be run during service or host events for proactive problem resolution - -<li>Automatic log file rotation - -<li>Support for implementing redundant monitoring hosts - -<li>Optional web interface for viewing current network status, notification and problem history, log file, etc. - -</ul> - - - - - -<p> - -<a name="requirements"></a> - -<strong><u>System Requirements</u></strong> - -</p> - -<p> - -The only requirement of running Nagios Core is a machine running Linux (or UNIX variant) that has network access and a C compiler installed (if installing from source code). - -</p> - -<p> - -You are <i>not required</i> to use the CGIs included with Nagios Core. However, if you do decide to use them, you will need to have the following software installed... - -</p> - - - -<ol> - -<li>A web server (preferrably <a href="http://www.apache.org" target="_top">Apache</a>) - -<li>Thomas Boutell's <a href="http://www.boutell.com/gd">gd library</a> version 1.6.3 or higher (required by the <a href="cgis.html#statusmap_cgi">statusmap</a> and <a href="cgis.html#trends_cgi">trends</a> CGIs) - -</ol> - - - -<p> - -<a name="licensing"></a> - -<strong><u>Licensing</u></strong> - -</p> - -<p class="SectionBody"> - -Nagios Core is licensed under the terms of the <a href="http://www.gnu.org/copyleft/gpl.html">GNU General Public License</a> Version 2 as published by the <a href="http://www.fsf.org">Free Software Foundation</a>. This gives you legal permission to copy, distribute and/or modify Nagios under certain conditions. Read the 'LICENSE' file in the Nagios distribution or read the <a href="http://www.gnu.org/copyleft/gpl.html">online version of the license</a> for more details. - -</p> - - - -<p> - -Nagios Core is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE WARRANTY OF DESIGN, MERCHANTABILITY, AND FITNESS FOR A PARTICULAR PURPOSE. - -</p> - - - -<p> - -<a name="acknowledgements"></a> - -<strong><u>Acknowledgements</u></strong> - -</p> - -<p> - -Several people have contributed to Nagios Core by either reporting bugs, suggesting improvements, writing plugins, etc. A list of some of the many contributors to the development of Nagios Core can be found in the THANKS file in the root of the Nagios Core distribution. - -</p> - - - -<p> - -<a name="downloading"></a> - -<strong><u>Downloading The Latest Version</u></strong> - -</p> - -<p> - -You can check for new versions of Nagios Core at <a href="http://www.nagios.org/download" target="_top">http://www.nagios.org/download</a>. - -</p> - - - -<hr> - - - -<br clear="all"> - -<div class="Disclaimer"> - -Nagios and the Nagios logo are trademarks of <a href="http://www.nagios.com/" target="_blank">Nagios Enterprises, LLC</a>. All other trademarks, servicemarks, registered trademarks, and registered servicemarks may be the property of their respective owner(s). - -</div> - - - -</body> - -</html> - Deleted: nagioscore/trunk/html/docs/activechecks.html =================================================================== --- nagioscore/trunk/html/docs/activechecks.html 2011-02-13 21:50:59 UTC (rev 141) +++ nagioscore/trunk/html/docs/activechecks.html 2011-02-13 21:54:15 UTC (rev 142) @@ -1,162 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> - - - -<html> - -<head> - -<title>Active Checks</title> - - - -<STYLE type="text/css"> - -<!-- - - .Default { font-family: verdana,arial,serif; font-size: 8pt; } - - .PageTitle { font-family: verdana,arial,serif; font-size: 16pt; font-weight: bold; } - ---> - -</STYLE> - - - -</head> - - - -<body bgcolor="#FFFFFF" text="black" class="Default"> - - - -<div align="center"> - -<img src="images/nagios.jpg" border="0" alt="Nagios" title="Nagios"> - -<h1 class="PageTitle">Active Checks</h1> - -</div> - - - -<hr> - - - -<p> - -<img src="images/upto.gif" border="0" align="middle" alt="Up To" title="Up To">Up To: <a href="toc.html">Contents</a><br> - -<img src="images/seealso.gif" border="0" align="middle" alt="See Also" title="See Also"> See Also: <a href="passivechecks.html">Passive Checks</a>, <a href="plugins.html">Plugins</a>, <a href="servicechecks.html">Service Checks</a>, <a href="hostchecks.html">Host Checks</a> - -</p> - - - -<p> - -<strong><u>Introduction</u></strong> - -</p> - - - -<p> - -Nagios is capable of monitoring hosts and services in two ways: actively and passively. Passive checks are described <a href="passivechecks.html">elsewhere</a>, so we'll focus on active checks here. Active checks are the most common method for monitoring hosts and services. The main features of actives checks as as follows: - -</p> - - - -<ul> - -<li>Active checks are initiated by the Nagios process</li> - -<li>Active checks are run on a regularly scheduled basis</li> - -</ul> - - - -<img src="images/activechecks.png" border="0" style="float: right;" alt="Active Checks"> - - - -<p> - -<strong><u>How Are Active Checks Performed?</u></strong> - -</p> - - - -<p> - -Active checks are initiated by the check logic in the Nagios daemon. When Nagios needs to check the status of a host or service it will execute a plugin and pass it information about what needs to be checked. The plugin will then check the operational state of the host or service and report the results back to the Nagios daemon. Nagios will process the results of the host or service check and take appropriate action as necessary (e.g. send notifications, run event handlers, etc). - -</p> - - - -<p> - -More information on how plugins work can be found <a href="plugins.html">here</a>. - -</p> - - - -<p> - -<strong><u>When Are Active Checks Executed?</u></strong> - -</p> - - - -<p> - -Active check are executed: - -</p> - -<ul> - -<li>At regular intervals, as defined by the <i>check_interval</i> and <i>retry_interval</i> options in your host and service definitions</li> - -<li>On-demand as needed</li> - -</ul> - - - -<p> - -Regularly scheduled checks occur at intervals equaling either the <i>check_interval</i> or the <i>retry_interval</i> in your host or service definitions, depending on what <a href="statetypes.html">type of state</a> the host or service is in. If a host or service is in a HARD state, it will be actively checked at intervals equal to the <i>check_interval</i> option. If it is in a SOFT state, it will be checked at intervals equal to the <i>retry_interval</i> option. - -</p> - - - -<p> - -On-demand checks are performed whenever Nagios sees a need to obtain the latest status information about a particular host or service. For example, when Nagios is determining the <a href="networkreachability.html">reachability</a> of a host, it will often perform on-demand checks of parent and child hosts to accurately determine the status of a particular network segment. On-demand checks also occur in the <a href="dependencychecks.html">predictive dependency check</a> logic in order to ensure Nagios has the most accurate status information. - -</p> - - - - - -<hr> - - - -</body> - -</html> - Deleted: nagioscore/trunk/html/docs/adaptive.html =================================================================== --- nagioscore/trunk/html/docs/adaptive.html 2011-02-13 21:50:59 UTC (rev 141) +++ nagioscore/trunk/html/docs/adaptive.html 2011-02-13 21:54:15 UTC (rev 142) @@ -1,200 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> - - - -<html> - -<head> - -<title>Adaptive Monitoring</title> - - - -<STYLE type="text/css"> - -<!-- - - .Default { font-family: verdana,arial,serif; font-size: 8pt; } - - .PageTitle { font-family: verdana,arial,serif; font-size: 16pt; font-weight: bold; } - ---> - -</STYLE> - - - -</head> - - - -<body bgcolor="#FFFFFF" text="black" class="Default"> - - - -<div align="center"> - -<img src="images/nagios.jpg" border="0" alt="Nagios" title="Nagios"> - -<h1 class="PageTitle">Adaptive Monitoring</h1> - -</div> - - - -<hr> - - - -<p> - -<img src="images/upto.gif" border="0" align="middle" alt="Up To" title="Up To">Up To: <a href="toc.html">Contents</a><br> - -<img src="images/seealso.gif" border="0" align="middle" alt="See Also" title="See Also"> See Also: <a href="extcommands.html">External Commands</a> - -</p> - - - -<p> - -<strong><u>Introduction</u></strong> - -</p> - - - -<p> - -Nagios allows you to change certain commands and host and service check attributes during runtime. I'll refer to this feature as "adaptive monitoring". Please note that the adaptive monitoring features found in Nagios will probably not be of much use to 99% of users, but they do allow you to do some neat things. - -</p> - - - -<p> - -<strong><u>What Can Be Changed?</u></strong> - -</p> - - - -<p> - -The following service check attributes can be changed during runtime: - -</p> - - - -<ul class="Default"> - -<li>Check command (and command arguments)</li> - -<li>Check interval</li> - -<li>Max check attempts</li> - -<li>Check timeperiod</li> - -<li>Event handler command (and command arguments)</li> - -</ul> - - - -<p> - -The following host check attributes can be changed during runtime: - -</p> - - - -<ul class="Default"> - -<li>Check command (and command arguments)</li> - -<li>Check interval</li> - -<li>Max check attempts</li> - -<li>Check timeperiod</li> - -<li>Event handler command (and command arguments)</li> - -</ul> - - - -<p> - -The following global attributes can be changed during runtime: - -</p> - - - -<ul class="Default"> - -<li>Global host event handler command (and command arguments)</li> - -<li>Global service event handler command (and command arguments)</li> - -</ul> - - - -<p> - -<strong><u>External Commands For Adaptive Monitoring</u></strong> - -</p> - - - -<p> - -In order to change global or host- or service-specific attributes during runtime, you must submit the appropriate <a href="extcommands.html">external command</a> to Nagios via the <a href="configmain.html#command_file">external command file</a>. The table below lists the different attributes that may be changed during runtime, along with the external command to accomplish the job. - -</p> - - - -<p> - -A full listing of external commands that can be used for adaptive monitoring (along with examples of how to use them) can be found online at the following URL: <a href="http://www.nagios.org/developerinfo/externalcommands/" target="_blank">http://www.nagios.org/developerinfo/externalcommands/</a> - -</p> - - - -<p> - -<img src="images/note.gif" border="0" align="bottom" alt="Note" title="Note"> Notes: - -</p> - - - -<ul> - -<li>When changing check commands, check timeperiods, or event handler commands, it is important to note that the new values for these options must have been defined before Nagios was started. Any request to change a command or timeperiod to one which had not been defined when Nagios was started is ignored.<br><br></li> - -<li>You can specify command arguments along with the actual command name - just seperate individual arguments from the command name (and from each other) using bang (!) characters. More information on how arguments in command definitions are processed during runtime can be found in the documentation on <a href="macros.html">macros</a>.</li> - -</ul> - - - - - -<hr> - - - -</body> - -</html> - Deleted: nagioscore/trunk/html/docs/addons.html =================================================================== --- nagioscore/trunk/html/docs/addons.html 2011-02-13 21:50:59 UTC (rev 141) +++ nagioscore/trunk/html/docs/addons.html 2011-02-13 21:54:15 UTC (rev 142) @@ -1,249 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> - - - -<html> - -<head> - -<title>Nagios Addons</title> - - - -<STYLE type="text/css"> - -<!-- - - .Default { font-family: verdana,arial,serif; font-size: 8pt; } - - .PageTitle { font-family: verdana,arial,serif; font-size: 16pt; font-weight: bold; } - ---> - -</STYLE> - - - -</head> - - - -<body bgcolor="#FFFFFF" text="black" class="Default"> - - - -<div align="center"> - -<img src="images/nagios.jpg" border="0" alt="Nagios" title="Nagios"> - -<h1 class="PageTitle">Nagios Addons</h1> - -</div> - - - -<hr> - - - -<p> - -<img src="images/upto.gif" border="0" align="middle" alt="Up To" title="Up To">Up To: <a href="toc.html">Contents</a><br> - -</p> - - - -<p><strong><u>Introduction</u></strong></p> - - - -<p> - -There are a lot of "addon" software packages that are available for Nagios. Addons can be used to extend Nagios' functionality or integrate Nagios with other applications. - -</p> - - - -<p> - -Addons are available for: - -</p> - - - -<ul> - -<li>Managing the config files through a web interface - -<li>Monitoring remote hosts (*NIX, Windows, etc.) - -<li>Submitting passive checks from remote hosts - -<li>Simplifying/extending the notification logic - -<li>...and much more - -</ul> - - - -<p> - -You can find many addons for Nagios by visiting: - -</p> - - - -<ul> - -<li><a href="http://www.nagios.org/">Nagios.org</a></li> - -<li><a href="http://www.sourceforge.net">SourceForge.net</a></li> - -<li><a href="http://www.nagiosexchange.org">NagiosExchange.org</a></li> - -</ul> - - - -<p> - -I'll give a brief introduction to a few of the addons that I've developed for Nagios... - -</p> - - - - - - - -<a name="nrpe"></a> - -<p><strong><u>NRPE</u></strong></p> - - - -<p> - -<img src="images/nrpe.png" border="0" alt="NRPE" title="NRPE" style="float: right; padding: 0 0 0 10px;"> - -</p> - - - -<p> - -NRPE is an addon that allows you to execute <a href="plugins.html">plugins</a> on remote Linux/Unix hosts. This is useful if you need to monitor local resources/attributes like disk usage, CPU load, memory usage, etc. on a remote host. Similiar functionality can be accomplished by using the <i>check_by_ssh</i> plugin, although it can impose a higher CPU load on the monitoring machine - especially if you are monitoring hundreds or thousands of hosts. - -</p> - - - -<p> - -The NRPE addon and documentation can be found at <a href="http://www.nagios.org/">http://www.nagios.org/</a>. - -</p> -<br clear="all"> - - - - -<a name="nsca"></a> - -<p><strong><u>NSCA</u></strong></p> - - - -<p> - -<img src="images/nsca.png" border="0" alt="NSCA" title="NSCA" style="float: right; padding: 0 0 0 10px;"> - -</p> - - - -<p> - -NSCA is an addon that allows you to send <a href="passivechecks.html">passive check</a> results from remote Linux/Unix hosts to the Nagios daemon running on the monitoring server. This is very useful in <a href="distributed.html">distributed</a> and <a href="redundancy.html">redundant/failover</a> monitoring setups. - -</p> - - - -<p> - -The NSCA addon can be found at <a href="http://www.nagios.org/">http://www.nagios.org/</a>. - -</p> - - - -<br clear="all"> - - - -<a name="ndoutils"></a> - -<p><strong><u>NDOUtils</u></strong></p> - - - -<p> - -<img src="images/ndoutils.png" border="0" alt="NDOUtils" title="NDOUtils" style="float: right; padding: 0 0 0 10px;"> - -</p> - - - -<p> - -NDOUtils is an addon that allows you to store all status information from Nagios in a MySQL database. Multiple instances of Nagios can all store their information in a central database for centralized reporting. This will likely serve as the basis for a new PHP-based web interface for Nagios in the future. - -</p> - - - -<p> - -The NDOUtils addon and documentation can be found at <a href="http://www.nagios.org/">http://www.nagios.org/</a>. - -</p> - - - -<br clear="all"> - -<a name="others"></a> - -<p><strong><u>Nagios Exchange - Hundreds of Other Addons</u></strong></p> - - - -<p> - -<a href="http://exchange.nagios.org/" target="_blank"><img src="images/nagiosexchange.png" border="0" alt="Nagios Exchange" title="Nagios Exchange" style="float: right; padding: 0 0 0 10px;"></a> - -</p> - -<p> -Hundreds of community-developed Nagios addons can be found on the Nagios Exchange website at <a href="http://exchange.nagios.org" target="_blank">exchange.nagios.org</a>. -</p> - -<br clear="all"> - - -<hr> - - - -</body> - -</html> - Deleted: nagioscore/trunk/html/docs/beginners.html =================================================================== --- nagioscore/trunk/html/docs/beginners.html 2011-02-13 21:50:59 UTC (rev 141) +++ nagioscore/trunk/html/docs/beginners.html 2011-02-13 21:54:15 UTC (rev 142) @@ -1,100 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> - - - -<html> - -<head> - -<title>Advice for Beginners</title> - - - -<STYLE type="text/css"> - -<!-- - - .Default { font-family: verdana,arial,serif; font-size: 8pt; } - - .PageTitle { font-family: verdana,arial,serif; font-size: 16pt; font-weight: bold; } - ---> - -</STYLE> - - - -</head> - - - -<body bgcolor="#FFFFFF" text="black" class="Default"> - - - -<div align="center"> - -<img src="images/nagios.jpg" border="0" alt="Nagios" title="Nagios"> - -<h1 class="PageTitle">Advice for Beginners</h1> - -</div> - - - -<hr> - - - -<p> - -<img src="images/upto.gif" border="0" align="middle" alt="Up To" title="Up To">Up To: <a href="toc.html">Contents</a><br> - -<img src="images/seealso.gif" border="0" align="middle" alt="See Also" title="See Also"> See Also: <a href="quickstart.html">Quickstart Installation Guide</a> - -</p> - - - - - -<p> - -Congratulations on choosing Nagios! Nagios is quite powerful and flexible, but it can take a lot of work to get it configured just the way you'd like. Once you become familiar with how it works and what it can do for you, you'll never want to be without it. :-) Here are some important things to keep in mind for first-time Nagios users: - -</p> - - - -<ol> - - - -<li><strong>Relax - it's going to take some time.</strong> Don't expect to be able to get things working exactly the way you want them right off the bat. it's not that easy. Setting up Nagios can involve a bit of work - partly because of the options that Nagios offers, partly because you need to know what to monitor on your network (and how best to do it).<br><br> - - - -<li><strong>Use the quickstart instructions.</strong> The <a href="quickstart.html">quickstart installation guide</a> is designed to get most new users up and running with a basic Nagios setup fairly quickly. Within 20 minutes you can have Nagios installed and monitoring your local system. Once that's complete, you can move on to learning how to configure Nagios to do more.<br><br> - - - -<li><strong>Read the documentation.</strong> Nagios can be tricky to configure when you've got a good grasp of what's going on, and nearly impossible if you don't. Make sure you read the documentation (particularly the sections on "Configuring Nagios" and "The Basics"). Save the advanced topics for when you've got a good understanding of the basics.<br><br> - - - -<li><strong>Seek the help of others.</strong> If you've read the documentation, reviewed the sample config files, and are still having problems, send an email message describing your problems to the <i>nagios-users</i> mailing list. Due to the amount of work that I have to do for this project, I am unable to answer most of the questions that get sent directly to me, so your best source of help is going to be the mailing list. If you've done some background reading and you provide a good problem description, odds are that someone will give you some pointers on getting things working properly. More information on subscribing to the mailing lists or searching the list archives can be found at <a href="http://www.nagios.org/support/">http://www.nagios.org/support/</a>. - -</ol> - - - - - -<hr> - - - -</body> - -</html> - Deleted: nagioscore/trunk/html/docs/cachedchecks.html =================================================================== --- nagioscore/trunk/html/docs/cachedchecks.html 2011-02-13 21:50:59 UTC (rev 141) +++ nagioscore/trunk/html/docs/cachedchecks.html 2011-02-13 21:54:15 UTC (rev 142) @@ -1,364 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> - - - -<html> - -<head> - -<title>Cached Checks</title> - - - -<STYLE type="text/css"> - -<!-- - - .Default { font-family: verdana,arial,serif; font-size: 8pt; } - - .PageTitle { font-family: verdana,arial,serif; font-size: 16pt; font-weight: bold; } - ---> - -</STYLE> - - - -</head> - - - -<body bgcolor="#FFFFFF" text="black" class="Default"> - - - -<div align="center"> - -<img src="images/nagios.jpg" border="0" alt="Nagios" title="Nagios"> - -<h1 class="PageTitle">Cached Checks</h1> - -</div> - - - -<hr> - - - -<p> - -<img src="images/upto.gif" border="0" align="middle" alt="Up To" title="Up To">Up To: <a href="toc.html">Contents</a><br> - -<img src="images/seealso.gif" border="0" align="middle" alt="See Also" title="See Also"> See Also: <a href="hostchecks.html">Host Checks</a>, <a href="servicechecks.html">Service Checks</a>, <a href="dependencychecks.html">Predictive Dependency Checks</a> - -</p> - - - -<p> - -<strong><u>Introduction</u></strong> - -</p> - - - -<img src="images/cachedchecks1.png" border="0" style="float: right;" alt="Cached Checks" title="Cached Checks"> - - - -<p> - -The performance of Nagios' monitoring logic can be significantly improved by implementing the use of cached checks. Cached checks allow Nagios to forgo executing a host or service check command if it determines a relatively recent check result will do instead. - -</p> - - - -<p> - -<strong><u>For On-Demand Checks Only</u></strong> - -</p> - - - -<p> - -Regularly scheduled host and service checks will not see a performance improvement with use of cached checks. Cached checks are only useful for improving the performance of on-demand host and service checks. Scheduled checks help to ensure that host and service states are updated regularly, which may result in a greater possibility their results can be used as cached checks in the future. - -</p> - - - -<p> - -For reference, on-demand host checks occur... - -</p> - - - -<ul> - -<li>When a service associated with the host changes state.</li> - -<li>As needed as part of the <a href="networkreachability.html">host reachability</a> logic.</li> - -<li>As needed for <a href="dependencychecks.html">predictive host dependency checks</a>.</li> - -</ul> - - - -<p> - -And on-demand service checks occur... - -</p> - - - -<ul> - -<li>As needed for <a href="dependencychecks.html">predictive service dependency checks</a>.</li> - -</ul> - - - -<p> - -<img src="images/note.gif" border="0" align="bottom" alt="Note" title="Note"> Note: Unless you make use of service dependencies, Nagios will not be able to use cached check results to improve the performance of service checks. Don't worry about that - its normal. Cached host checks are where the big performance improvements lie, and everyone should see a benefit there. - -</p> - - - - - -<p> - -<strong><u>How Caching Works</u></strong> - -</p> - - - -<img src="images/cachedchecks.png" border="0" style="float: right; clear: both;" alt="Cached Check Logic" title="Cached Check Logic"> - - - -<p> - -When Nagios needs to perform an on-demand host or service check, it will make a determination as to whether it can used a cached check result or if it needs to perform an actual check by executing a plugin. It does this by checking to see if the last check of the host or service occured within the last X minutes, where X is the cached host or service check horizon. - -</p> - - - -<p> - -If the last check was performed within the timeframe specified by the cached check horizon variable, Nagios will use the result of the last host or service check and will <i>not</i> execute a new check. If the host or service has not yet been checked, or if the last check falls outside of the cached check horizon timeframe, Nagios will execute a new host or service check by running a plugin. - -</p> - - - -<p> - -<strong><u>What This Really Means</u></strong> - -</p> - - - -<p> - -Nagios performs on-demand checks because it need to know the current state of a host or service <i>at that exact moment</i> in time. Utilizing cached checks allows you to make Nagios think that recent check results are "good enough" for determining the current state of hosts, and that it doesn't need to go out and actually re-check the status of that host or service. - -</p> - - - -<p> - -The cached check horizon tells Nagios how recent check results must be in order to reliably reflect the current state of a host or service. For example, with a cached check horizon of 30 seconds, you are telling Nagios that if a host's state was checked sometime in the last 30 seconds, the result of that check should still be considered the current state of the host. - -</p> - - - -<p> - -The number of cached check results that Nagios can use versus the number of on-demand checks it has to actually execute can be considered the cached check "hit" rate. By increasing the cached check horizon to equal the regular check interval of a host, you could theoretically achieve a cache hit rate of 100%. In that case all on-demand checks of that host would use cached check results. What a performance improvement! But is it really? Probably not. - -</p> - - - -<p> - -The reliability of cached check result information decreases over time. Higher cache hit rates require that previous check results are considered "valid" for longer periods of time. Things can change quickly in any network scenario, and there's no guarantee that a server that was functioning properly 30 seconds ago isn't on fire right now. There's the tradeoff - reliability versus speed. If you have a large cached check horizon, you risk having unreliable check result values being used in the monitoring logic. - -</p> - - - -<p> - -Nagios will eventually determine the correct state of all hosts and services, so even if cached check results prove to unreliably represent their true value, Nagios will only work with incorrect information for a short period of time. Even short periods of unreliable status information can prove to be a nuisance for admins, as they may receive notifications about problems which no longer exist. - -</p> - - - -<p> - -There is no standard cached check horizon or cache hit rate that will be acceptable to every Nagios users. Some people will want a short horizon timeframe and a low cache hit rate, while others will want a larger horizon timeframe and a larger cache hit rate (with a low reliability rate). Some users may even want to disable cached checks altogether to obtain a 100% reliability rate. Testing different horizon timeframes, and their effect on the reliability of status information, is the only want that an individual user will find the "right" value for their situation. More information on this is discussed below. - -</p> - - - - - -<p> - -<strong><u>Configuration Variables</u></strong> - -</p> - - - -<p> - -The following variables determine the timeframes in which a previous host or service check result may be used as a cached host or service check result: - -</p> - - - -<ul> - -<li>The <a href="configmain.html#cached_host_check_horizon">cached_host_check_horizon</a> variable controls cached host checks.</li> - -<li>The <a href="configmain.html#cached_service_check_horizon">cached_service_check_horizon</a> variable controls cached service checks.</li> - -</ul> - - - -<p> - -<strong><u>Optimizing Cache Effectiveness</u></strong> - -</p> - - - -<p> - -In order to make the most effective use of cached checks, you should: - -</p> - - - -<ul> - -<li>Schedule regular checks of your hosts</li> - -<li>Use MRTG to graph statistics for 1) on-demand checks and 2) cached checks</li> - -<li>Adjust cached check horizon variables to fit your needs</li> - -</ul> - - - -<p> - -You can schedule regular checks of your hosts by specifying a value greater than 0 for <i>check_interval</i> option in your <a href="objectdefinitions.html#host">host definitions</a>. If you do this, make sure that you set the <i>max_check_attempts</i> option to a value greater than 1, or it will cause a big performance hit. This potential performance hit is describe in detail <a href="hostchecks.html">here</a>. - -</p> - - - -<img src="images/cachedcheckgraphs.png" border="0" style="float: right; clear: both;" alt="Cached Checks Graph" title="Cached Checks Graph"> - - - -<p> - -A good way to determine the proper value for the cached check horizon options is to compare how many on-demand checks Nagios has to actually run versus how may it can use cached values for. The <a href="nagiostats.html">nagiostats</a> utility can produce information on cached checks, which can then be <a href="mrtggraphs.html">graphed with MRTG</a>. Example MRTG graphs that show cached vs. actual on-demand checks are shown to the right. - -</p> - - - -<p> - -The monitoring installation which produced the graphs above had: - -</p> - - - -<ul> - -<li>A total of 44 hosts, all of which were checked at regular intervals</li> - -<li>An average (regularly scheduled) host check interval of 5 minutes</li> - -<li>A <a href="configmain.html#cached_host_check_horizon">cached_host_check_horizon</a> of 15 seconds</li> - -</ul> - - - -<p> - -The first MRTG graph shows how many regularly scheduled host checks compared to how many cached host checks have occured. In this example, an average of 53 host checks occur every five minutes. 9 of these (17%) are on-demand checks. - -</p> - - - -<p> - -The second MRTG graph shows how many cached host checks have occurred over time. In this example an average of 2 cached host checks occurs every five minutes. - -</p> - - - -<p> - -Remember, cached checks are only available for on-demand checks. Based on the 5 minute averages from the graphs, we see that Nagios is able to used cached host check results every 2 out of 9 times an on-demand check has to be run. That may not seem much, but these graphs represent a small monitoring environment. Consider that 2 out of 9 is 22% and you can start to see how this could significantly help improve host check performance in large environments. That percentage could be higher if the cached host check horizon variable value was increased, but that would reduce the reliability of the cached host state information. - -</p> - - - -<p> - -Once you've had a few hours or days worth of MRTG graphs, you should see how many host and service checks were done by executing plugins versus those that used cached check results. Use that information to adjust the cached check horizon variables appropriately for your situation. Continue to monitor the MRTG graphs over time to see how changing the horizon variables affected cached check statistics. Rinse and repeat as necessary. - -</p> - - - -<br clear="all"> - - - -<hr> - - - -</body> - -</html> - Deleted: nagioscore/trunk/html/docs/cgiauth.html =================================================================== --- nagioscore/trunk/html/docs/cgiauth.html 2011-02-13 21:50:59 UTC (rev 141) +++ nagioscore/trunk/html/docs/cgiauth.html 2011-02-13 21:54:15 UTC (rev 142) @@ -1,516 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> - - - -<html> - -<head> - -<title>Authentication And Authorization In The CGIs</title> - - - -<STYLE type="text/css"> - -<!-- - - .Default { font-family: verdana,arial,serif; font-size: 8pt; } - - .PageTitle { font-family: verdana,arial,serif; font-size: 16pt; font-weight: bold; } - ---> - -</STYLE> - - - -</head> - - - -<body bgcolor="#FFFFFF" text="black" class="Default"> - - - -<div align="center"> - -<img src="images/nagios.jpg" border="0" alt="Nagios" title="Nagios"> - -<h1 class="PageTitle">Authentication And Authorization In The CGIs</h1> - -</div> - - - -<hr> - - - -<p> - -<img src="images/upto.gif" border="0" align="middle" alt="Up To" title="Up To">Up To: <a href="toc.html">Contents</a><br> - -<img src="images/seealso.gif" border="0" align="middle" alt="See Also" title="See Also"> See Also: <a href="configcgi.html">CGI Configuration File Options</a>, <a href="cgis.html">Information on the CGIs</a> - -</p> - - - -<p> - -<strong><u>Introduction</u></strong> - -</p> - - - -<p> - -This documentation describes how the Nagios CGIs decide who has access to view monitoring and configuration information, and who can submit commands to the Nagios daemon through the web interface. - -</p> - - - - - -<a name="definitions"></a> - -<p> - -<strong><u>Definitions</u></strong> - -</p> - - - -<p> - -Before continuing, it is important that you understand the meaning of and difference between authenticated users and authenticated contacts: - -</p> - - - -<ul> - -<li>An <b>authenticated user</b> is an someone who has authenticated to the web server with a username and password and has been granted access to the Nagios web interface. - -<li>An <b>authenticated contact</b> is an authenticated user whose username matches the short name of a <a href="objectdefinitions.html#contact">contact definition</a>. - -</ul> - - - - - -<p> - -<a name="config_web_users"></a> - -<strong><u>Setting Up Authenticated Users</u></strong> - -</p> - - - -<p> - -Assuming you configured your web server as described in the <a href="quickstart.html">quickstart guide</a>, it should require that you authenticate before accessing the Nagios CGIs. You should also have one user account (<i>nagiosadmin</i>) that can access the CGIs. - -</p> - - - -<p> - -As you define more <a href="objectdefinitions.html#contact">contacts</a> for receiving host and service notifications, you'll most likely want to let them access the Nagios web interface. You can use the following command to add additional users who can authenticate to the CGIs. Replace <username> with the actual username you want to add. In most cases, the username should match the short name of a <a href="objectdefinitions.html#contact">contact</a> that has been defined. - -</p> - - - -<pre> - -htpasswd /usr/local/nagios/etc/htpasswd.users <username> - -</pre> - - - -<p> - -<a name="enable_cgi_auth"></a> - -<strong><u>Enabling Authentication/Authorization Functionality In The CGIs</u></strong> - -</p> - - - -<p> - -The next thing you need to do is make sure that the CGIs are configured to use the authentication and authorization functionality in determining what information and/or commands users have access to. This is done be setting the <a href="configcgi.html#use_authentication">use_authentication</a> variable in the <a href="configcgi.html">CGI configuration file</a> to a non-zero value. Example: - -</p> - - - -<pre> - -use_authentication=1 - -</pre> - - - -<p> - -Okay, you're now done with setting up basic authentication/authorization functionality in the CGIs. - -</p> - - - - - -<p> - -<a name="default_rights"></a> - -<strong><u>Default Permissions To CGI Information</u></strong> - -</p> - - - -<p> - -So what default permissions do users have in the CGIs by default when the authentication/authorization functionality is enabled? - -</p> - - - -<table border="1" class="Default"> - -<tr bgcolor="#cbcbcb"> - -<td>CGI Data</td> - -<td>Authenticated Contacts<sup><a href="#definitions">*</a></sup></td> - -<td>Other Authenticated Users<sup><a href="#definitions">*</a></sup></td> - -</tr> - -<tr> - -<td>Host Status Information</td> - -<td bgcolor="#00FF00">Yes</td> - -<td>No</td> - -</tr> - -<tr> - -<td>Host Configuration Information</td> - -<td bgcolor="#00FF00">Yes</td> - -<td>No</td> - -</tr> - -<tr> - -<td>Host History</td> - -<td bgcolor="#00FF00">Yes</td> - -<td>No</td> - -</tr> - -<tr> - -<td>Host Notifications</td> - -<td bgcolor="#00FF00">Yes</td> - -<td>No</td> - -</tr> - -<tr> - -<td>Host Commands</td> - -<td bgcolor="#00FF00">Yes</td> - -<td>No</td> - -</tr> - -<tr> - -<td>Service Status Information</td> - -<td bgcolor="#00FF00">Yes</td> - -<td>No</td> - -</tr> - -<tr> - -<td>Service Configuration Information</td> - -<td bgcolor="#00FF00">Yes</td> - -<td>No</td> - -</tr> - -<tr> - -<td>Service History</td> - -<td bgcolor="#00FF00">Yes</td> - -<td>No</td> - -</tr> - -<tr> - -<td>Service Notifications</td> - -<td bgcolor="#00FF00">Yes</td> - -<td>No</td> - -</tr> - -<tr> - -<td>Service Commands</td> - -<td bgcolor="#00FF00">Yes</td> - -<td>No</td> - -</tr> - -<tr> - -<td>All Configuration Information</td> - -<td>No</td> - -<td>No</td> - -</tr> - -<tr> - -<td>System/Process Information</td> - -<td>No</td> - -<td>No</td> - -</tr> - -<tr> - -<td>System/Process Commands</td> - -<td>No</td> - -<td>No</td> - -</tr> - -</table> - - - -<br> - - - -<p> - -<i>Authenticated contacts<sup><a href="#definitions">*</a></sup></i> are granted the following permissions for each <b>service</b> for which they are contacts (but not for services for which they are not contacts)... - -</p> - -<ul> - -<li>Authorization to view service status information - -<li>Authorization to view service configuration information - -<li>Authorization to view history and notifications for the service - -<li>Authorization to issue service commands - -</ul> - - - -<p> - -<i>Authenticated contacts<sup><a href="#definitions">*</a></sup></i> are granted the following permissions for each <b>host</b> for which they are contacts (but not for hosts for which they are not contacts)... - -</p> - -<ul> - -<li>Authorization to view host status information - -<li>Authorization to view host configuration information - -<li>Authorization to view history and notifications for the host - -<li>Authorization to issue host commands - -<li>Authorization to view status information for all services on the host - -<li>Authorization to view configuration information for all services on the host - -<li>Authorization to view history and notification information for all services on the host - -<li>Authorization to issue commands for all services on the host - -</ul> - - - -<p> - -It is important to note that by default <b>no one</b> is authorized for the following... - -</p> - -<ul> - -<li>Viewing the raw log file via the <a href="cgis.html#showlog_cgi">showlog CGI</a> - -<li>Viewing Nagios process information via the <a href="cgis.html#extinfo_cgi">extended information CGI</a> - -<li>Issuing Nagios process commands via the <a href="cgis.html#cmd_cgi">command CGI</a> - -<li>Viewing host group, contact, contact group, time period, and command definitions via the <a href="cgis.html#config_cgi">configuration CGI</a> - -</ul> - - - -<p> - -You will undoubtably want to access this information, so you'll have to assign additional rights for yourself (and possibly other users) as described below... - -</p> - - - -<p> - -<a name="additional_rights"></a> - -<strong><u>Granting Additional Permissions To CGI Information</u></strong> - -</p> - - - -<p> - -You can grant <i>authenticated contacts</i> or other <i>authenticated users</i> permission to additional information in the CGIs by adding them to various authorization variables in the <a href="configcgi.html">CGI configuration file</a>. I realize that the available options don't allow for getting really specific about particular permissions, but its better than nothing.. - -</p> - - - -<p> - -Additional authorization can be given to users by adding them to the following variables in the CGI configuration file... - -</p> - -<ul> - -<li><a href="configcgi.html#authorized_for_system_information">authorized_for_system_information</a> - -<li><a href="configcgi.html#authorized_for_system_commands">authorized_for_system_commands</a> - -<li><a href="configcgi.html#authorized_for_configuration_information">authorized_for_configuration_information</a> - -<li><a href="configcgi.html#authorized_for_all_hosts">authorized_for_all_hosts</a> - -<li><a href="configcgi.html#authorized_for_all_host_commands">authorized_for_all_host_commands</a> - -<li><a href="configcgi.html#authorized_for_all_services">authorized_for_all_services</a> - -<li><a href="configcgi.html#authorized_for_all_service_commands">authorized_for_all_service_commands</a> - -</ul> - - - -<p> - -<a name="cgi_auth_requirements"></a> - -<strong><u>CGI Authorization Requirements</u></strong> - -</p> - - - -<p> - -If you are confused about the authorization needed to access various information in the CGIs, read the <i><b>Authorization Requirements</b></i> section for each CGI as described <a href="cgis.html">here</a>. - -</p> - - - - - -<p> - -<a name="secure_web_servers"></a> - -<strong><u>Authentication On Secured Web Servers</u></strong> - -</p> - - - -<p> - -If your web server is located in a secure domain (i.e., behind a firewall) or if you are using SSL, you can define a default username that can be used to access the CGIs. This is done by defining the <a href="configcgi.html#default_user_name">default_user_name</a> option in the <a href="configcgi.html">CGI configuration file</a>. By defining a default username that can access the CGIs, you can allow users to access the CGIs without necessarily having to authenticate to the web server. You may want to use this to avoid having to use basic web authentication, as basic authentication transmits passwords in clear text over the Internet. - -</p> - -<p> - -<strong>Important:</strong> Do <i>not</i> define a default username unless you are running a secure web server and are sure that everyone who has access to the CGIs has been authenticated in some manner. If you define this variable, anyone who has not authenticated to the web server will inherit all rights you assign to this user! - -</p> - - - -<hr> - - - -</body> - -</html> - Deleted: nagioscore/trunk/html/docs/cgiincludes.html =================================================================== --- nagioscore/trunk/html/docs/cgiincludes.html 2011-02-13 21:50:59 UTC (rev 141) +++ nagioscore/trunk/html/docs/cgiincludes.html 2011-02-13 21:54:15 UTC (rev 142) @@ -1,152 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> - - - -<html> - -<head> - -<title>Custom CGI Headers and Footers</title> - - - -<STYLE type="text/css"> - -<!-- - - - - .Default { font-family: verdana,arial,serif; font-size: 8pt; } - - .PageTitle { font-family: verdana,arial,serif; font-size: 16pt; font-weight: bold; } - - - ---> - -</STYLE> - - - -</head> - - - -<body bgcolor="#FFFFFF" text="black" class="Default"> - - - -<div align="center"> - -<img src="images/nagios.jpg" border="0" alt="Nagios" title="Nagios"> - -<h1 class="PageTitle">Custom CGI Headers and Footers</h1> - -</div> - - - -<hr> - - - -<p> - -<img src="images/upto.gif" border="0" align="middle" alt="Up To" title="Up To">Up To: <a href="toc.html">Contents</a><br> - -<img src="images/seealso.gif" border="0" align="middle" alt="See Also" title="See Also"> See Also: <a href="cgis.html">Information on the CGIs</a> - -</p> - - - -<p> - -<strong><u>Introduction</u></strong> - -</p> - - - -<p> - -If you're doing custom installs of Nagios for clients, you may want to have a custom header and/or footer displayed in the output of the <a href="cgis.html">CGIs</a>. This is particularly useful for displaying support contact information, etc. to the end user. - -</p> - - - -<p> - -It is important to note that, unless they are executable, custom header and footer files are not pre-processed in any way before they are displayed. The contents of the header and footer include files are simply read and displayed in the CGI output. That means they can only contain information a web browser can understand (HTML, JavaScript, etc.). - -</p> - - - -<p> - -If the custom header and footer files are executable, then the files are executed and their output returned to the user, so they should output valid HTML. Using this you can run your own custom designed CGI to insert data into the nagios display. This has been used to insert graphs from rrdtool using ddraw and command menus into the nagios display pane. The execuable customer header and footer files are run with the same CGI environment as the main nagios CGI, so your files can parse the query information, authenticated user information, etc. to produce appropriate output. - -</p> - - - - - -<p> - -<strong><u>How Does It Work?</u></strong> - -</p> - - - -<p> - -You can include custom headers and footers in the output of the CGIs by dropping some appropriately named HTML files in the <i>ssi/</i> subdirectory of the Nagios HTML directory (i.e. <i>/usr/local/nagios/share/ssi</i>). - -</p> - - - -<p> - -Custom headers are included immediately after the <BODY>> tag in the CGI output, while custom footers are included immediately before the closing </BODY> tag. - -</p> - - - -<p>There are two types of customer headers and footers: - -</p> - - - -<ul> - -<li>Global headers/footers. These files should be named <i>common-header.ssi</i> and <i>common-footer.ssi</i>, respectively. If these files exist, they will be included in the output of all CGIs.<br><br> - -<li>CGI-specific headers/footers. These files should be named in the format <i>CGINAME-header.ssi</i> and <i>CGINAME-footer.ssi</i>, where <i>CGINAME</i> is the physical name of the CGI without the .cgi extension. For example, the header and footer files for the <a href="cgis.html#summary_cgi">alert summary CGI</a> (summary.cgi) would be named <i>summary-header.ssi</i> and <i>summary-footer.ssi</i>, respectively. - -</ul> - - - -<p> - -You are not required to use any custom headers or footers. You can use only a global header if you wish. You can use only CGI-specific headers and a global footer if you wish. Whatever you want. Really. - -</p> - - - -<hr> - - - -</body> - -</html> - Deleted: nagioscore/trunk/html/docs/cgis.html =================================================================== --- nagioscore/trunk/html/docs/cgis.html 2011-02-13 21:50:59 UTC (rev 141) +++ nagioscore/trunk/html/docs/cgis.html 2011-02-13 21:54:15 UTC (rev 142) @@ -1,1381 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> - - - -<html> - -<head> - -<title>Information On The CGIs</title> - - - -<STYLE type="text/css"> - -<!-- - - .Default { font-family: verdana,arial,serif; font-size: 8pt; } - - .PageTitle { font-family: verdana,arial,serif; font-size: 16pt; font-weight: bold; } - ---> - -</STYLE> - - - -</head> - - - -<body bgcolor="#FFFFFF" text="black" class="Default"> - - - -<div align="center"> - -<img src="images/nagios.jpg" border="0" alt="Nagios" title="Nagios"> - -<h1 class="PageTitle">Information On The CGIs</h1> - -</div> - - - -<hr> - - - -<p> - -<img src="images/upto.gif" border="0" align="middle" alt="Up To" title="Up To">Up To: <a href="toc.html">Contents</a><br> - -<img src="images/seealso.gif" border="0" align="middle" alt="See Also" title="See Also"> See Also: <a href="configcgi.html">CGI Configuration File Options</a>, <a href="cgiauth.html">Authentication And Authorization In The CGIs</a>, <a href="cgiincludes.html">CGI Footers and Headers</a>, <a href="cgisecurity.html">CGI Security</a> - -</p> - - - -<p> - -<strong><u>Introduction</u></strong> - -</p> - - - -<p> - -The various CGIs distributed with Nagios are described here, along with the authorization requirements for accessing and using each CGI. By default the CGIs require that you have authenticated to the web server and are authorized to view any information you are requesting. More information on configuring authorization can be found <a href="cgiauth.html">here</a>. - -</p> - - - -<p> - -<strong><u>Index</u></strong> - -</p> - -<p> - -<a href="#status_cgi">Status CGI</a><br> - -<a href="#statusmap_cgi">Status map CGI</a><br> - -<a href="#statuswml_cgi">WAP interface CGI</a><br> - -<a href="#statuswrl_cgi">Status world CGI (VRML)</a><br> - -<a href="#tac_cgi">Tactical overview CGI</a><br> - -<a href="#outages_cgi">Network outages CGI</a><br> - -<a href="#config_cgi">Configuration CGI</a><br> - -<a href="#cmd_cgi">Command CGI</a><br> - -<a href="#extinfo_cgi">Extended information CGI</a><br> - -<a href="#showlog_cgi">Event log CGI</a><br> - -<a href="#history_cgi">Alert history CGI</a><br> - -<a href="#notifications_cgi">Notifications CGI</a><br> - -<a href="#trends_cgi">Trends CGI</a><br> - -<a href="#avail_cgi">Availability reporting CGI</a><br> - -<a href="#histogram_cgi">Alert histogram CGI</a><br> - -<a href="#summary_cgi">Alert summary CGI</a><br> - -</p> - - - - - -<a name="status_cgi"></a> - -<table border="0" width="100%" class="Default"> - -<tr> - -<td bgcolor="#cbcbcb" ><strong>Status CGI</strong></td> - -</tr> - -</table> - - - -<table border="0" class="Default"> - -<tr> - -<td align=left><img src="images/cgi-status-a.png" border=0 alt="Status CGI - Details"></td> - -<td align=left><img src="images/cgi-status-b.png" border=0 alt="Status CGI - Overview"></td> - -<td align=left><img src="images/cgi-status-c.png" border=0 alt="Status CGI - Summary"></td> - -<td align=left><img src="images/cgi-status-d.png" border=0 alt="Status CGI - Grid"></td> - -</tr> - -</table> - - - -<table border="0" class="Default"> - -<tr> - -<td>File Name:</td> - -<td><font color="red"><strong>status.cgi</strong></font></td> - -</tr> - -</table> - - - -<table border="0" width="100%" class="Default"> - -<tr> - -<td align=left valign=top width="50%"> - -<p> - -<strong>Description:</strong><br> - -This is the most important CGI included with Nagios. It allows you to view the current status of all hosts and services that are being monitored. The status CGI can produce two main types of output - a status overview of all host groups (or a particular host group) and a detailed view of all services (or those associated with a particular host). - -<p> - -<strong>Authorization Requirements:</strong><br> - -<ul class="Default"> - -<li>If you are <a href="configcgi.html#authorized_for_all_hosts"><i>authorized for all hosts</i></a> you can view all hosts <b>and</b> all services. - -<li>If you are <a href="configcgi.html#authorized_for_all_services"><i>authorized for all services</i></a> you can view all services. - -<li>If you are an <i>authenticated contact</i> you can view all hosts and services for which you are a contact. - -</ul> - -</td> - -</tr> - -</table> - - - - - -<a name="statusmap_cgi"></a> - -<table border="0" width="100%" class="Default"> - -<tr> - -<td bgcolor="#cbcbcb"><strong>Status Map CGI</strong></td> - -</tr> - -</table> - - - -<table border="0" class="Default"> - -<tr> - -<td align=left><img src="images/cgi-statusmap.png" border=0 alt="Status Map CGI"></td> - -</tr> - -</table> - - - -<table border="0" class="Default"> - -<tr> - -<td>File Name:</td> - -<td><font color="red"><strong>statusmap.cgi</strong></font></td> - -</tr> - -</table> - - - -<table border="0" width="100%" class="Default"> - -<tr> - -<td align=left valign=top width="50%"> - -<p> - -<strong>Description:</strong><br> - -This CGI creates a map of all hosts that you have defined on your network. The CGI uses Thomas Boutell's <a href="http://www.boutell.com/gd/">gd</a> library (version 1.6.3 or higher) to create a PNG image of your network layout. The coordinates used when drawing each host (along with the optional pretty icons) are taken from <a href="objectdefinitions.html#host">host</a> definitions. If you'd prefer to let the CGI automatically generate drawing coordinates for you, use the <a href="configcgi.html#default_statusmap_layout">default_statusmap_layout</a> directive to specify a layout algorithm that should be used. - -</p> - -<p> - -<strong>Authorization Requirements:</strong><br> - -<ul class="Default"> - -<li>If you are <a href="configcgi.html#authorized_for_all_hosts"><i>authorized for all hosts</i></a> you can view all hosts. - -<li>If you are an <i>authenticated contact</i> you can view hosts for which you are a contact. - -</ul> - -<br> - -Note: Users who are not authorized to view specific hosts will see <i>unknown</i> nodes in those positions. I realize that they really shouldn't see <i>anything</i> there, but it doesn't make sense to even generate the map if you can't see all the host dependencies... - -</td> - -</tr> - -</table> - - - - - -<a name="statuswml_cgi"></a> - -<table border="0" width="100%" class="Default"> - -<tr> - -<td bgcolor="#cbcbcb"><strong>WAP Interface CGI</strong></td> - -</tr> - -</table> - - - -<table border="0" class="Default"> - -<tr> - -<td align=left><img src="images/cgi-statuswml.png" border=0 alt="WAP Interface CGI"></td> - -</tr> - -</table> - - - -<table border="0" class="Default"> - -<tr> - -<td>File Name:</td> - -<td><font color="red"><strong>statuswml.cgi</strong></font></td> - -</tr> - -</table> - - - -<table border="0" width="100%" class="Default"> - -<tr> - -<td align=left valign=top width="50%"> - -<p> - -<strong>Description:</strong><br> - -This CGI serves as a WAP interface to network status information. If you have a WAP-enabled device (i.e. an Internet-ready cellphone), you can view status information while you're on the go. Different status views include hostgroup summary, hostgroup overview, host detail, service detail, all problems, and unhandled problems. In addition to viewing status information, you can also disable notifications and checks and acknowledge problems from your cellphone. Pretty cool, huh? - -</p> - -<p> - -<strong>Authorization Requirements:</strong><br> - -<ul class="Default"> - -<li>If you are <a href="configcgi.html#authorized_for_system_information"><... [truncated message content] |