README

DISCLAIMER

  The Author, the University of California, the University of
  California at Davis, and the Electrical Engineering department at
  the University of California at Davis assume no responsibility for
  damage or loss of system performance as a direct or indirect result
  of the use of this software.  This software is provided "as is"
  without express or implied warranty.

TABLE OF CONTENTS

  Disclaimer
  Table Of Contents
  Introduction
* Supported Architectures
  Availability
* Installation
  Copying And Copyrights
* Frequently Asked Questions
* Code Update Announcements / Mailing List(S)
  Extensibility
  Example Usage 
  Configuration
  Snmpv1 Vs. Snmpv2
  Thanks
  Submitting Bug Reports
  Closing

  * = Required Reading.

INTRODUCTION

  This package contains a port and modified code of the CMU 2.1.2.1
  snmp agent.  It has been modified to allow extensibility quickly
  and easily.  It is far from the best and most configurable system;
  but hey: it's free.
  
SUPPORTED ARCHITECTURES

  It has been known to work on the following architectures:  
  (Please see the FAQ file for more details)

     hppa1.1-hp-hpux9.05
       - known to work under 9.03, 9.01
     hppa1.1-hp-hpux10.10
       - known to work under 10.01
     mips-dec-ultrix4.4
       - known to work under 4.2, 4.3
     sparc-sun-solaris2.5
       - known to work under 2.3, 2.4
     sparc-sun-sunos4.1.4
       - known to work under 4.1.2, 4.1.3
     *-netbsd1.1
       - arp table mib disabled
       - known to work under 1.0, 1.2
     alpha-dec-osf3.2
     *-freebsd2.?
     bsdi?

  Please let us know if you compile it on other OS versions and it
  works for you so we can add them to the above list.

  Porting:  Please! read the PORTING file.

AVAILABILITY

  ftp.ece.ucdavis.edu:/pub/snmp/ucd-snmp.README
  ftp.ece.ucdavis.edu:/pub/snmp/ucd-snmp.tar.gz

  or [European mirror]:

  sunsite.cnlab-switch.ch:/mirror/ucd-snmp/ucd-snmp.README
  sunsite.cnlab-switch.ch:/mirror/ucd-snmp/ucd-snmp.tar.gz

INSTALLATION

  See the INSTALL file distributed with this package.

COPYING AND COPYRIGHTS
  
  See the COPYING file distributed with this package.

FREQUENTLY ASKED QUESTIONS

  See the FAQ file distributed with this package.

CODE UPDATE ANNOUNCEMENTS / MAILING LIST(S)

  See the NEWS file and the ChangeLog file for details on what has
  changed between releases.

  We hate broadcasting announce messages to other mailing lists and
  newsgroups, so there is a mailing list set up to handle release
  announcements.  Any time we put new software out for ftp, we'll mail
  this fact to ucd-snmp-announce@ece.ucdavis.edu.  To
  subscribe/unsubscribe yourself to/from this list, mail a note to
  ucd-snmp-announce-request@ece.ucdavis.edu with a subject line of
  'subscribe' or 'unsubscribe'.  We will post new announcements on a
  very infrequent basis to the other channels (the snmp mailing lists
  and comp.protocols.snmp), but only for major code revisions and not
  for bug-fix patches or small feature upgrades.

  The above mailing list is not a general purpose discussion list.  A
  separate list has been created for that purpose.  To subscribe to
  it, mail a note to ucd-snmp-request@ece.ucdavis.edu with a
  subject line of 'subscribe' or 'unsubscribe'.  To use it, mail to 
  ucd-snmp@ece.ucdavis.edu.

  In addition, there is yet another mailing list called
  ucd-snmp-coders@ece.ucdavis.edu, which is where all bug reports,
  questions and patches should be sent to.  The traffic volume is a
  lot higher and is really only of interest to those who intend to
  work on the code and submit patches frequently.  To join it, mail a
  "subscribe" request to ucd-snmp-coders-request@ece.ucdavis.edu.

EXTENSIBILITY

  The agent that comes with this package is extensible through use of
  shell scripts and other methods.  See the configuration manual pages
  (snmpd.conf) and the EXAMPLE.conf file for details.

  Note:  This agent uses its own API for extensibility.  The IETF's
  agentx working group is working on developing a common API for
  subagent extensibility.  When they have finished the development of
  their specifications, we will begin working on implementing them.

EXAMPLE USAGE 

  See the 'EXAMPLE.conf' file in the top level source directory (you
  must build the package for this file to be generated).  Do NOT look
  at the EXAMPLE.conf.def file.  It will only confuse you.

CONFIGURATION

  See man/snmpd.conf.5 and the EXAMPLE.conf file mentioned above.

SNMPv1 vs. SNMPv2

  Typically, we doubt you want people to look at most of your mib tree.
  By defining GLOBALSECURITY in the config.h file, you can restrict
  access to any of the mibs implemented in this package to this
  security type.  I define mine to SNMPV2AUTH, for authenticated
  requests only.  I then define the SECURITYEXCEPTIONS to allow .100
  requests, since HP Openview can only use SNMPv1 protocols.  The CMU
  code does not support encryption due to export regulation in the
  United States, so it is not possible to restrict access to encrypted
  transmissions.

  If you don't understand anything we have said here, select the
  default security model of SNMPV1 when prompted by the configure
  script and you shouldn't have problems.

THANKS

  The following people have contributed various patches and
  improvements.  To them we owe our deepest thanks (and you do too!):

    Dan A. Dickey <ddickey@transition.com>
    Dave Shield <D.T.Shield@csc.liv.ac.uk>
    Giovanni S. Marzot <gmarzot@baynetworks.com>
    Niels Baggesen <recnba@mediator.uni-c.dk>
    Mike Perik <mikep@crt.com>
    Sanjai Narain <narain@thumper.bellcore.com>
    francus@metsny.delphi.com
    Gary Palmer <gpalmer@freebsd.org>
    Marc G. Fournier <scrappy@ki.net>
    Gary A. Hayward <gah@bellcore.com>
    Jennifer Bray <jbray@origin-at.co.uk>
    Philip Guenther <guenther@gac.edu>
    Elwyn B Davies <edavies@origin-at.co.uk>

  We've probably forgotten people on this list.  Let us know if you've
  contributed code and we've left you out.

SUBMITTING BUG REPORTS

  The best way to submit a bug report is to use the enclosed
  "bug-report" script.  Please run the script on the architecture you
  are having problems with, as it automatically mails us with uname
  output for our usage.

  Please submit all bug reports and patches to
  ucd-snmp-coders@ece.ucdavis.edu.  *Please* include what version of
  the ucd-snmp package you are using and what architecture(s) you're
  using, as well as detailed information about exactly what is wrong.
  If you intend to submit a patch as well, please read the PORTING
  file before you do so.  Thanks!

CLOSING

  we love patches.  Send some to us!  But before you do, please see
  the 'PORTING' file for information on helping us out with the
  process of integrating your patches.

  Also, We're interested if anyone actually uses/likes/hates/whatever
  this package...  Mail us a note and let us know what you think of it!

  Have fun,

    Wes Hardaker
    ucd-snmp-coders@ece.ucdavis.edu