File: INSTALL

package info (click to toggle)
mrtg-ping-probe 2.2.0-5
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 232 kB
  • sloc: perl: 754; makefile: 80; sh: 25
file content (164 lines) | stat: -rw-r--r-- 5,897 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164

mrtg-ping-probe - A Round Trip Time and Packet Loss Probe

			for

	MRTG - The Multi Router Traffic Grapher.


Copyright (c) 1997-2003 Peter W. Osel <pwo@pwo.de>.
All rights reserved.


See the file COPYRIGHT in the distribution for the exact terms.

Please read the file README first.

Please make sure you have the latest release of mrtg-ping-probe.
Read the file README to find out where to get the latest release.


Make sure you have the following software installed on your system:

- perl <http://www.perl.com/pub/language/info/software.html>
	I use version 5.003, but any later version will most likely
	work without any problem.

- MRTG	<http://ee-staff.ethz.ch/~oetiker/webtools/mrtg/mrtg.html>
	I use version 2.8.8, but any 2.x version will most likely work
	without any problem.

- a ping program
	You need a ping program that displays a summary of the round
	trip times upon termination or timeout.  mrtg-ping-probe knows
	how to call the system's native ping program for supported
	systems (see the file README for a list).  See below for
	platform specific information and for information on adding
	support for a new system.


Check the script mrtg-ping-probe, and adapt the path to your perl if
necessary.  Put the script into a place where MRTG can call it, e.g.
the your MRTG binary directory.

Edit your mrtg.cfg file to add statements for the devices you want to
ping.  See mrtg.cfg-ping for an example.  You might also use and
customize the contributed script mrtg-ping-cfg to generate entries
suitable for your environment.

Optionally create the documentation in the format you like best, e.g.
	make html
	make man
	make tex


Platform specific notes:


* OS/2

- mrtg-ping-probe has been tested on OS/2 Warp4 with Perl 5.002
- mrtg-ping-probe "requires" perl 5.003 or better, you might need
	to change the line "require 5.003;" to "require 5.002;"
- the Target line in your mrtg.cfg needs to include perl5:
	Target[pwo.de.ping]: `perl5 mrtg-ping-probe pwo.de`
- depending on where you placed files, you might need to list
	the absolute pathname for mrtg-ping-probe.
- test mrtg-ping-probe with the commands
	perl5 mrtg-ping-probe -V
	perl5 mrtg-ping-probe pwo.de


* Solaris 2 and possibly others

- some ping programs try to map IP addresses to hostnames.  A ping
	can fail, if your DNS cannot resolve the address.  If you use
	IP addresses in mrtg.cfg and want to suppress IP address to
	hostname mapping, pass the appropriate ping option, using the
	new -o option.  E.g. on Solaris your Target[] declaration to
	ping the device at address 10.1.2.3 would look like this:

	Target[10.1.2.3]: `/usr/local/sbin/mrtg-ping-probe -o -n 10.1.2.3`


* Windows 95/98/NT 4.0/2000

- the native ping program on Windows 95 and Windows NT 4.0 do not
	display a summary of the round trip times upon termination or
	timeout.  You need to install a ping program that displays the
	summary information, e.g. the ping program of Windows 98 or
	Windows 2000.  You can also use WinSock 2.x (see:
	http://www.sockets.com/).
- the Target line in your mrtg.cfg might need to include the complete
	pathname to your perl executable and to the mrtg-ping-probe
	script:
	Target[pwo.de.ping]: `c:\perl5\perl c:\mrtg-2.5.2\mrtg-ping-probe pwo.de`
- make sure that the quotes in the Target line are "back-quotes" (aka
	accent-grave, back-ticks, or as one Windows user once described
	it:  "The ` is the one next to the 1 key and NOT the single
	quote below the double quote key." ;-)


* some Linux, and possibly other platforms.

- some ping programs won't stop until they received the configured
	number of ECHO_RESPONSE packets.  If your target is unreachable,
	these ping will just keep sending ECHO_RESPONSE packets, and
	mrtg-ping-probe might seem to hang.  In this case use the
	timeout option (-t timeout) to abort the ping after a reasonable
	time.

	You should configure a timeout, if the manual page of your ping
	mentions the phrase "(and receiving)" for the count option:

	-c count
	Stop after sending (and receiving) count ECHO_RESPONSE packets.


* FreeBSD

- on freebsd > 3.x 'ping -s' is only allowed to be used by root.  We no
	longer pass the packet size option to ping on freebsd, unless
	we run as root (which we shouldn't).


* Adding support for a new platform:

- make sure you have the latest release of mrtg-ping-probe (See the
	file README where to find it)
- make sure that the native ping program displays a summary of the
	round trip times upon termination or get and install a version
	that does so, e.g. ftp://ftp.nikhef.nl/pub/network/ping.tar.Z.
- determine perl's idea about your platform name:
	perl -e 'use Config; print $Config{"osname"}, "\n"'
- add a line to the %ping associative array for your platform, e.g.:
	'linux' =>	"/bin/ping -c $count -s $length $host",
	where 'linux' is the output of the above perl command,
	/bin/ping the absolute pathname of your ping program,
	also check the documentation to adapt the arguments to ping.
- test whether mrtg-ping-probe can find the summary information of your ping:
	mrtg-ping-probe some.host.name
	if you get the error message
		"ERROR: Could not find ping summary for some.host.name"
	you have to adapt the regular expression that matches the ping output
	in function ping().
- send context diffs of your changes to me, Peter W. Osel <pwo@pwo.de>,
	so we can keep this distribution in sync.
	Also send the following information:

	output of the command "uname -a"

	output of the command "man ping"

	output of the ping command when pinging some hosts ten times, e.g.
		ping some.host.name 56 10
		ping -c 10 some.host.name
	(The actual command arguments may be different)

	complete pathname of the native ping program, or if you use a
	non-native ping program, information on which ping you use.



@(#) $Id: INSTALL,v 2.3 2003/09/13 18:04:29 pwo Exp $
@(#) mrtg-ping-probe release $Name: Release_2_2_0 $