Commit | Line | Data |
---|---|---|
c5de9e27 AT |
1 | .TH icmpmonitor 1 "Version 1.2" |
2 | .ds ]W September 1999 | |
3 | .SH NAME | |
4 | icmpmonitor \- multiple host monitoring tool | |
5 | .SH SYNOPSIS | |
6 | .ta 6n | |
7 | \fBicmpmonitor\fP | |
8 | [-f \fIcfg file\fP] | |
9 | [-d] | |
10 | [-v] | |
11 | [-r] | |
12 | ||
13 | .br | |
14 | .SH DESCRIPTION | |
15 | The | |
16 | .I icmpmonitor | |
17 | Using the InterNet Control Message Protocol (ICMP) "ECHO" facility, | |
18 | monitors several hosts, and notify admin if some of them are down. | |
19 | ||
20 | .SH OPTIONS | |
21 | .PP | |
22 | .I icmpmonitor\fP accepts following options: | |
23 | .TP 8 | |
24 | .B \-d | |
25 | if specified, the program will detach itself from control terminal and work in 'daemon' mode. All error messages will go to syslog. | |
26 | .TP 8 | |
27 | .B \-f \fP<\fIconfiguration file\fP> | |
28 | Name of configuration file. | |
29 | .TP 8 | |
30 | .B \-v | |
31 | if specified, the program will produce more log messages describing its activity. | |
32 | .TP 8 | |
33 | .B \-r | |
34 | Execute DOWN command repeatedly until host will be up again. If it is not specified, the command is excuted only once. | |
35 | ||
36 | .SH CONFIGURATION FILE FORMAT | |
37 | .PP | |
38 | You need to create the configuration file. You can find a sample one in the distribution named 'sample.cfg'. The file consists of one or more lines. Lines starting with "#" are | |
39 | comments and are ignored. Each line must contain following fields, separeated by spaces or | |
40 | tabs: | |
41 | ||
42 | .TP 8 | |
43 | .B Hostname \fP | |
44 | Name of the host which will be monitored. | |
45 | .TP 8 | |
46 | .B Ping Interval \fP | |
47 | Interval (in seconds) on which ICMP packets will be sent to the host to check it's status. | |
48 | .TP 8 | |
49 | .B Max. Delay \fP | |
50 | Maximum delay (in seconds) after which host considered to be "down" if no response was received. | |
51 | .TP 8 | |
52 | .B "Up" Command \fP | |
53 | Command which will be executed when host became accessible. | |
54 | This command is executed | |
55 | using "sh -c" and may contain shell syntax. If command contain spaces or tabs | |
56 | it should be quoted. | |
57 | If the command is executing some lenghy operation it is recommended to start | |
58 | it as detached process (for example using '&'), because icmpmonitor will not resume monitoring of this | |
59 | and other hosts until command is finished. | |
60 | .TP 8 | |
61 | .B "Down" Command \fP | |
62 | Command which will be executed when host became not accessible. | |
63 | This command will be executed | |
64 | using "sh -c" and may contain shell syntax. If command contain spaces or tabs | |
65 | it should be quoted. | |
66 | If the command is executing some lenghy operation it is recommended to start | |
67 | it as detached process (for example using '&'), because icmpmonitor will not resume monitoring of this | |
68 | and other hosts until command is finished. | |
69 | .TP 8 | |
70 | .B Startup Condition (optional) \fp | |
71 | Condition of the host that should be assumed on startup. | |
72 | Possible values are "auto", "down", "none" and "up". | |
73 | The parameter is optional with "up" being the default value. | |
74 | The main purpose is controlling which up/down commands will be launched on startup. | |
75 | "auto" detects the state of the host silently on startup and doesn't launch any command first. | |
76 | "down" assumes the host is down and executes the up command on the first ping recieved. Similar to "up". | |
77 | "none" starts either up or down command on startup. | |
78 | ||
79 | .SH BUGS | |
80 | It was reported that some systems (e.g. Solaris 2.5) do not have function | |
81 | vsnprintf. In such case icmpmonitor will use vsprintf instead, but this could | |
82 | cause buffer overflow problem. | |
83 | ||
84 | If you find any other bugs, please follow link to bug tracking system | |
85 | from ICMPmonitor project home page to file them. | |
86 | .TP 8 | |
87 | ||
88 | .PP | |
89 | .SH SEE ALSO | |
90 | .PP | |
91 | \fBhttp://www.crocodile.org/software.html\fP | |
92 | .SH AUTHOR | |
93 | .PP | |
94 | Vadim Zaliva <lord@crocodile.org> | |
95 | .SH CONTRIBUTORS | |
96 | .PP | |
97 | I would like to thank following people for help in developement of this software: | |
98 | Alexandr S. Dubovicov <shurik@te.net.ua>, | |
99 | Andrey Arhipov <andy@paco.net>, | |
100 | Bernhard Lutzmann <belu@gmx.at>, | |
101 | Ingo Saitz <Salz@users.sourceforge.net> | |
102 | ||
103 | ||
104 | ||
105 |