README
1In here are various scripts and utilities that you may find useful, but which
2are not part of the main distribution. This also includes any user-submitted
3scripts.
4The scripts in here are not as well supported as the main application. Any
5of them written by someone other than myself are supported by that person - so
6report any problems to them, and not to me.
7You may well have to modify these scripts by changing the Perl path on the
8first line, or by changing the extension or the file execute permissions.
9Some of them also require other configuration. See any accompanying
10documentation, or header comments in the files themselves.
11
12graphprune.pl Steve Shipway
13 This is a script that can be run nightly to clean up old graphs in the
14 graphs directory, in order to save space. Public domain.
15
16extensions
17 This directory holds various plugin extensions for routers.cgi
18
19buildwan.pl Steve Shipway
20 This more complex script - which requires Net::SNMP to be installed - will
21 take a 'seed' router, and then explore your entire WAN (as far as possible)
22 and create a set of MRTG files suitable for use with routers.cgi. The
23 created files will have a number of routers.cgi specific directives added.
24 Public domain software.
25
26rrdextend.pl Steve Shipway
27 This script will extend the RRAs in all the RRD files for a given MRTG
28 .cfg file. You will need the rrdtool executable in your path to run it.
29 You need to do this in order to use the extended time windows options.
30 Some of you may wish to modify the location of the rrdtool executable and
31 perl executable coded into the script.
32 This too is public domain.
33
34getstats.sh Steve Shipway
35 Statistics gathering backend for server monitor. Called from inetd. This
36 is used by the gather.pl and servers.cgi extensions.
37
38gather.pl Steve Shipway
39 This is the perl script, supposed to be run every 5 mins, that contacts the
40 getstats.sh program on remote UNIX hosts to get the load stats. This data
41 is then placed into an RRD and reported by routers.cgi when the servers=yes
42 option has been set.
43
44targetnames Steve Shipway
45 This script is used to attempt to generate the [targetnames] section of
46 the routers2.conf file, by querying the routers via SNMP. It uses the
47 various SNMP libraries supplied with MRTG.
48
49cfgmaker_host Steve Shipway
50 This will make a MRTG .cfg file, with lots of routers.cgi extensions,
51 for a specified host. It will search for the UCD and host MIBs in
52 order to make targets, including the interfaces. It is supposed to
53 be given a server name as a parameter. Public domain.
54
55rrd-archive.pl Steve Shipway
56 This is a script to run nightly, to generate the archived .rrd files
57 used by routers.cgi to do historical graphs. GPL
58
59mrtg-nrpe.sh Steve Shipway
60 A wrapper to allow you to collect data in MRTG format from the Nagios
61 remote agent, nrpe. Unix shellscript, Public domain.
62
63mrtg-pnsclient.pl Steve Shipway
64 A perl script to allow you to collect data in MRTG format from the
65 Nagios/NetSaint remote agent, pNSclient. This is a great way to collect
66 data remotely from a Windows Perfmon counter.
67
68vmware_monitor.pl Steve Shipway
69 A perl script to dynamically retrieve stats from a VMWare server, and
70 create .rrd and .cfg files appropriately.
71
72dashboard Steve Shipway
73 Some CGI scripts to work with the SLickboard Flash tool to display
74 MRTG data as a dashobard gauge, graph, or bar chart.
75
76rrdcached
77 Information on how to make Routers2 and MRTG work with the rrdcached
78 caching daemon for rrdtool.
79
80checkagent Steve Shipway
81 A tool to check a remote host for the nsclient, nrpe or snmp agents
82
83check_ucd Steve Shipway
84 An MRTG/Nagios plugin to let you run a Nagios plugin via the UCD SNMP
85 daemon, and query the output
86
87