--- /dev/null
+<!doctype html public "-//w3c//dtd html 4.0 transitional//en">
+<html>
+<head>
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+ <meta name="GENERATOR" content="Mozilla/4.61 [en] (X11; U; Linux 2.2.12-20 i686) [Netscape]">
+ <title>spong.hosts</title>
+</head>
+<body>
+
+<hr>
+<h1>
+<a NAME="spong.hosts_name_0"></a>NAME</h1>
+<b>spong.hosts</b> - define hosts and services to monitor
+<p>
+<hr>
+<h1>
+<a NAME="spong.hosts_description_0"></a>DESCRIPTION</h1>
+The spong.hosts file defines two things. 1) What hosts you want to monitor
+(and the attributes associated with each host), and 2) What humans should
+be contact when a given host has problems (and the attributes associated
+with each human).
+<p>Each host should have the following attributes associated with it:
+<pre> * services the network services running on that host
+
+
+</pre>
+Optionally, the follow attributes can also be assigned to a host:
+<pre> * down time period the host is scheduled down, problems
+
+ are not reported during this time.
+
+ * ip_addr a list of ip addresses corresponding to multiple
+
+ interfaces the machine might have.
+
+
+</pre>
+The services is a string listing the valid services seperated by spaces.
+Currently, valid services are ``dns'' (if you have the Net::DNS Perl module
+installed), ``ftp'', ``smtp'', ``http'', ``imap'', ``pop3'', ``nntp'',
+``nfs'', ``ntp'' and``ssh'' although more checks will be added in
+the future. The can include any addition network checks that you have developed
+(see <b><a href="spong-network.html">spong-network</a></b> for more details)
+. Any host listed is automatically checked for network connectivity (via
+ping).
+<p>The down attribute is a list of ``downtimes''. It is a list (well reference
+to one anyway) of one or more strings in the following format - ``d:hh:mm-hh:mm''.
+``d'' is the day of the week (0-6, 0 = Sunday, 6 = Saturday), if ``d''
+is ``*'', then every day of the week is matched. The string to the right
+of the day is the start and end time of the down time in 24 hour format
+<p>The ip_addr attribute is a list (well reference to one anyway) of IP
+address that the machine responds to.
+<p>Each human that is defined should have the following attributes associated
+with it:
+<pre> * name name of the person to contact</pre>
+And one or more of the following attributes assigned to each human for
+messaging when there are problems
+<br>
+<pre> * email email address
+
+ * skytel skytel pager number
+
+ * alltelsms phone number of a phone subscribered to Alltel Communications SMS service.
+
+ * teletouch teletouch pager number
+
+ * teletouch_short teletouch pages numer for small alpha pagers</pre>
+
+<p>
+<br>
+<p>These attributes are messaging functions for sending out notifictions
+to people. All of the messing methods are message modules that are load
+by the spoing-message as a plugin. The attributes listed above are
+the message functions that are part of the current Spong distribution.
+New messaging modules can be easily be developed (see the <b><a href="spong-message.html">spong-message</a></b>
+manual and the <a href="developer-guide.html#modules">Developer Guide</a>
+for more details).
+<p>
+<hr>
+<h1>
+<a NAME="spong.hosts_format_0"></a>FORMAT</h1>
+The spong.conf file is simply Perl code that gets imported by each spong
+program, so the only real format restrictions is just what is syntactically
+correct in Perl (which some would say is anything 8-).
+<p>What is expected in this file are the definitions for two hashes of
+hashes (in Perl speak). The <b>%HOSTS</b> hash, and the <b>%HUMANS</b>
+hash. If you are not comfortable with Perl lingo, then just think of them
+as stanza definitions.
+<p>First, the HUMANS. The following describes the <b>%HUMANS</b> hash.
+<pre> %HUMANS = ( [stanza], [stanza], [stanza] );</pre>
+where [stanza] is a second hash, that looks like the following:
+<pre> 'unix-staff' => { name => 'Midrange On-call Staff',
+
+ email => 'its-unix@uiowa.edu',
+
+ skytel => '1234567' },</pre>
+What this says is that the 'unix-staff' human has the following attributes
+(name = Midrange On-call Staff, email = <a href="MAILTO:its-unix@uiowa.edu">its-unix@uiowa.edu</a>,
+skytel = 1234567).
+<p>Now, the HOSTS. The following describes the <b>%HOSTS</b> hash.
+<pre> %HOSTS = ( [stanza], [stanza], [stanza] );</pre>
+where [stanza] is a second hash, that looks like the following:
+<pre> 'www.uiowa.edu' => { services => 'ftp smtp http',
+
+ ip_addr => ['192.168.15.2','10.2.124.200'],</pre>
+
+<pre> down => [ '*:0015-0030','6:23:00-23:59'] }</pre>
+What this says is that the 'www.uiowa.edu' host has the following attributes
+(services = ftp smtp http; ip address=192.168.15.2 and 10.2.124.200;
+and down time of 12:15AM-12:30AM every day and from 11:00PM-12:00PM on
+Saturdays).
+<p>I know the format can be a little odd at first, but I chose it because
+of both its simplicity to work with in the code (I don't have to parse
+anything - Perl does all the work), and because it is easy to extend -
+adding additional attributes is quite straightforward.
+<p>
+<hr>
+<h1>
+<a NAME="spong.hosts_examples_0"></a>EXAMPLES</h1>
+Here are some lines from our spong.hosts file to show you possible configurations.
+<pre> %HUMANS = (
+
+ 'unix-staff' => { name => 'Midrange On-call Staff',
+
+ email => 'its-unix@school.edu',
+
+
+
+ 'edhill' => { name => 'Ed Hill',
+
+ email => 'ed-hill@school.edu',
+
+ skytel => '1234567' },
+
+ );
+
+ %HOSTS = (
+
+ 'strobe.weeg.school.edu' => { services => 'dns ftp smtp http',
+
+ ip_addr => [ '128.255.1.3',
+
+ '128.255.64.3' ],
+
+ down => [ "*:05:30-06:30",
+
+ "0:00:00-04:00 ] },
+
+ 'www.school.edu' => { services => 'ftp smtp http' },
+
+ );
+
+
+
+
+</pre>
+
+<h1>
+
+<hr WIDTH="100%">COMPATABILITY</h1>
+In a future release of spong the %HUMAN configuration information will
+be moved into the spong.message configuration file. It is currenly being
+retained in the spong.hosts file for compatability.
+<br>
+<hr>
+<h1>
+<a NAME="spong.hosts_see_0"></a>SEE ALSO</h1>
+the <i>spong-server</i> manpage , the <i>spong-network</i> manpage , the
+<i>spong-message</i> manpage
+<p>
+<hr>
+<h1>
+<a NAME="spong.hosts_author_0"></a>AUTHOR</h1>
+Ed Hill (<a href="MAILTO:ed-hill@uiowa.edu">ed-hill@uiowa.edu</a>), Unix
+System Administrator, The University of Iowa
+<br>Stephen L Johnson (<a href="MAILTO:stephen.johnson@mail.state.ar.us">stephen.johnson@mail.state.ar.us</a>)
+or (<a href="MAILTO:sjohnson@monsters.org">sjohnson@monsters.org</a>),
+Unix System Administator, DIS - State of Arkansas
+<p>Based on code/ideas from Sean MacGuire (BB), and Helen Harrison (Pong).
+</body>
+</html>
projects / spong.git / commitdiff