
Minimal documentation for RouterD and ServerD
---------------------------------------------

** NOTE: 21/4/98

This has been re-written a heap since the last notes.
Most of the concepts are the same, but there is no longer
a problem on the month changeover of the last month's data
not being avaliable as all data is now split by week and
if a request is made for data beyond the last 7 day boundary,
the last two week's data are read.

Code has been sped up a lot in this version - it pre-calculates
the SNMP variable lists instead of working them out all the time.

The software versions now recommended are the perl module
SNMP-1.7 or later and the UCD SNMP library 3.3.1 or later.

Earlier versions are known to work with the perl module SNMP-1.6
and the CMU SNMP library 3.4 (note - earlier than this is
seriously flawed and should never be used to talk to a Cisco
router).

The most recent release of the UCD SNMP Libray can be found at:
ftp://ftp.ece.ucdavis.edu/pub/snmp/ucd-snmp.tar.gz

The most recent release of the Perl5/SNMP module can be found at:
ftp:/ftp.wellfleet.com/netman/snmp/perl5/SNMP.tar.gz

The MIB to use is included here as etc/small.mib - it is *very*
small.

A quick summary of all the files present use (see also any
details below):

.:
  README
          this file

bin:
  DiskD
          monitors BusLogic disk usage via ssh and /proc files
  RouterD
          monitors router and switch port usage
  ServerD
          monitors Bay/Annex terminal server usage

cgi-bin:
  CurrentDialup
          ugly, old graphs of dialup utilization
  CurrentDisk
          graphs per disk of BusLogic disk usage via webgraph.pl
  CurrentHost
          graphs per host of BusLogic disk usage via webgraph.pl
  CurrentSummary
          traffic graphs per router/switch via webgraph.pl
  CurrentTable
          traffic tables per router/switch via webtable.pl
  CurrentTraffic
          traffic graphs per interface via webgraph.pl

etc:
  *.pid
          PID files for DiskD/RouterD/ServerD
  init.d/*
          startup/shutdown scripts for DiskD/RouterD/ServerD
  small.mib
          the minaturized MIB file for this software
  transfer.sh
          used to transfer the port tables for Bay/Annex terminal
          server stuff

lib:
  CYGPORTS.pl
          Ports controlled by elysium (UWA-specific)
  DiskD/*
          data from DiskD, grouped by week
  ELPORTS.pl
          Ports controlled by elysium (UWA-specific)
  RouterD/*
          data from RouterD, grouped by week
  ServerD/*
          data from ServerD, grouped by week
  config.pl
          the UWA config file (with "sensitive" communities renamed)
          also grep for "community" in bin/RouterD
  disk.pl
          library for disk info graphing, uses webgraph.pl
  pixels/*
          pixel GIFs
  table.pl
          library for traffic tables, uses webtable.pl
  traffic.pl
          library for traffic graphs, uses webgraph.pl
  webgraph.pl
          webgraph.pl library
  webtable.pl
          webtable.pl library

src:
  makepixels.c
          makes the pixel gif files; included for completeness

** NOTE: 6/11/97

Added bin/DiskD, etc/init.d/DiskD, etc.  This is for monitoring
BusLogic disks.  Must have ssh access to the destination hosts.

** NOTE: 12/2/96

cgi-bin/CurrentTable, lib/table.pl and lib/traffic.pl are newer than
this documentation.  They exist.

** End note.

Welcome to RouterD/ServerD.  If you have found this file, I've
probably given you a copy of them, or you've got the job of
maintaining them.  They are originally based on the code by
Bruce Morgan (from Curtin) used on the PARNet web pages.  They
use a perl-snmp module and a bug-fixed version of the snmp 3.1/3.2
library for linux (one small bug wrt 5-byte integers returned from
Ciscos).  That's about all that's needed to run them.

Most configuration is in lib/config.pl.

bin/RouterD and bin/ServerD have some hardcoded values but not
many.

$home is set in bin/RouterD, bin/ServerD and the three cgi scripts
(cgi-bin/CurrentDialup, cgi-bin/CurrentSummary and
cgi-bin/CurrentTraffic).  This should be the name of the directory
this README file should be in (the base of the tree for RouterD
and ServerD).

The MIB is in etc/small.mib.  At time of writing this document,
the MIB contains 120 lines, 16 of which are blank (very small for
a MIB).

The pid files (etc/RouterD.pid, etc/ServerD.pid) are used by the
System V (Debian Linux) startup/stop scripts in etc/init.d.

etc/transfer.sh is run from cron every 4 hours and transfers
ELPORTS.pl and CYGPORTS.pl - the annex port data files.

src/makepixels.c was used to make the one-pixel gif files in
lib/pixels.

The actual data is stored in lib/RouterD and lib/ServerD.

David <luyer@ucs.uwa.edu.au>
