user/net-snmp/README

   1                README file for net-snmp Version: 5.5
   2
   3 DISCLAIMER
   4
   5   The Authors assume no responsibility for damage or loss of system
   6   performance as a direct or indirect result of the use of this
   7   software.  This software is provided "as is" without express or
   8   implied warranty.
   9
  10 TABLE OF CONTENTS
  11
  12   Disclaimer
  13   Table Of Contents
  14   Introduction
  15 * Supported Architectures
  16   Availability
  17   Web Page
  18 * Installation
  19   Copying And Copyrights
  20 * Frequently Asked Questions
  21   Helping Out
  22 * Code Update Announcements
  23 * Mailing Lists
  24   Agent Extensibility
  25   Example Agent Configuration and Usage
  26   Configuration
  27   Submitting Bug Reports
  28   Closing
  29   Thanks
  30
  31   * = Required Reading.
  32
  33 INTRODUCTION
  34
  35   This package was originally based on the CMU 2.1.2.1 snmp code.  It
  36   has been greatly modified, restructured, enhanced and fixed.  It
  37   hardly looks the same as anything that CMU has ever released.  It
  38   was renamed from cmu-snmp to ucd-snmp in 1995 and later renamed from
  39   ucd-snmp to net-snmp in November 2000.
  40
  41   This README file serves as a starting place to learn about the
  42   package, but very little of the documentation is contained within
  43   this file.  The FAQ is an excellent place to start as well.
  44   Additionally, there are a bunch of README files for specific
  45   architectures and specific features.  You might wish to look at some
  46   of these other files as well.
  47
  48 SUPPORTED ARCHITECTURES
  49
  50   Please see the FAQ for this information.
  51
  52   Please let us know if you compile it on other OS versions and it
  53   works for you so we can add them to the above list.
  54
  55   Porting:  Please! read the PORTING file.
  56
  57   Also note that many architecture have architecture specific README
  58   files, so you should check to see if there is one appropriate to
  59   your platform.
  60
  61 AVAILABILITY
  62
  63   Download:
  64     - http://www.net-snmp.org/download/
  65     - ftp://ftp.net-snmp.org/pub/sourceforge/net-snmp/
  66   Web page:
  67     - http://www.net-snmp.org/
  68   Project Wiki:
  69     - http://www.net-snmp.org/wiki/
  70   Sourceforge Project page:
  71     - http://sourceforge.net/projects/net-snmp
  72   Mirrors:
  73     - US:        ftp://ftp.freesnmp.com/mirrors/net-snmp/
  74
  75   The old ucd-snmp.ucdavis.edu web site and ftp server is now
  76   offline and should not be accessed any longer.
  77
  78 WEB PAGES
  79
  80   http://www.net-snmp.org/
  81   http://sourceforge.net/projects/net-snmp
  82   http://www.net-snmp.org/wiki/
  83
  84 INSTALLATION
  85
  86   See the INSTALL file distributed with this package.
  87
  88 COPYING AND COPYRIGHTS
  89
  90   See the COPYING file distributed with this package.
  91
  92 FREQUENTLY ASKED QUESTIONS
  93
  94   See the FAQ file distributed with this package.
  95   This is also available on the project Wiki at
  96
  97      http://www.net-snmp.org/wiki/index.php/FAQ
  98
  99   so that the wider Net-SNMP community can help maintain it!
 100
 101 HELPING OUT
 102
 103   This is a project worked on by people around the net.  We'd love
 104   your help, but please read the PORTING file first.  Also, subscribe
 105   to the net-snmp-coders list described below and mention what you're
 106   going to work on to make sure no one else is already doing so!
 107   You'll also need to keep up to date with the latest code snap shot,
 108   which can be obtained from CVS using the information found at
 109   http://www.net-snmp.org/cvs/.
 110
 111   Contributions to the Net-SNMP source code in any form are greatly
 112   appreciated.  We expect the parties providing such contributions to
 113   have the right to contribute them to the Net-SNMP project or that
 114   the parties that do have the right have directed the person
 115   submitting the contribution to do so.  In addition, all contributors
 116   need to be aware that if the contribution is accepted and
 117   incorporated into the Net-SNMP project, it will be redistributed
 118   under the terms of the license agreement used for the entire body of
 119   work that comprises the Net-SNMP project (see the COPYING file for
 120   details).  If this license agreement ever changes the contribution
 121   will continue to be released under any new licenses as well.  Thank
 122   you, in advance, for your gracious contributions.
 123
 124 CODE UPDATE ANNOUNCEMENTS
 125
 126   See the NEWS file and the ChangeLog file for details on what has
 127   changed between releases.
 128
 129   We hate broadcasting announce messages to other mailing lists and
 130   newsgroups, so there is a mailing list set up to handle release
 131   announcements.  Any time we put new software out for ftp, we'll mail
 132   this fact to net-snmp-announce@lists.sourceforge.net.  See the
 133   MAILING LISTS section described below to sign up for these
 134   announcements.
 135
 136   We will post new announcements on a very infrequent basis to the
 137   other channels (the other snmp mailing lists and newsgroups like
 138   comp.protocols.snmp), but only for major code revisions and not for
 139   bug-fix patches or small feature upgrades.
 140
 141 MAILING LISTS
 142
 143   The lists:
 144
 145     A number of mailing lists have been created for support of the project:
 146     The main ones are:
 147
 148       net-snmp-announce@lists.sourceforge.net  -- For official announcements
 149       net-snmp-users@lists.sourceforge.net     -- For usage discussions
 150       net-snmp-coders@lists.sourceforge.net    -- For development discussions
 151
 152     The -coders list is intended for discussion on development of code
 153     that will be shipped as part of the package.  The -users list is
 154     for general discussion on configuring and using the package,
 155     including issues with coding user-developed applications (clients,
 156     managers, MIB modules, etc).
 157
 158     Please do *NOT* send messages to both -users and -coders lists.
 159     This is completely unnecessary, and simply serves to further
 160     overload (and annoy) the core development team.   If in doubt,
 161     just use the -users list.
 162
 163
 164     The other lists of possible interest are:
 165
 166       net-snmp-cvs@lists.sourceforge.net       -- For cvs update announcements
 167       net-snmp-bugs@lists.sourceforge.net      -- For Bug database update announcements
 168       net-snmp-patches@lists.sourceforge.net   -- For Patch database update announcements
 169
 170     Please do NOT post messages to these lists (or to the announce list above).
 171     Bug reports and Patches should be submitted via the Source Forge tracker
 172     system.  See the main project web pages for details.
 173
 174     To subscribe to any of these lists, please see:
 175
 176       http://www.net-snmp.org/lists/
 177
 178
 179   Archives:
 180     The archives for these mailing lists can be found by following links at
 181
 182       http://www.net-snmp.org/lists/
 183
 184 AGENT EXTENSIBILITY
 185
 186   The agent that comes with this package is extensible through use of
 187   shell scripts and other methods.  See the configuration manual pages
 188   (like snmpd.conf) and run the snmpconf perl script for further details.
 189
 190   You can also extend the agent by writing C code directly.  The agent
 191   is extremely modular in nature and you need only create new files,
 192   re-run configure and re-compile (or link against its libraries).  No
 193   modification of the distributed source files are necessary.  See the
 194   following files for details on how to go about this:
 195   http://www.net-snmp.org/tutorial-5/toolkit/,
 196   agent/mibgroup/examples/*.c
 197
 198   Also, see the local/mib2c program and its README file for help in
 199   turning a textual mib description into a C code template.
 200
 201   We now support AgentX for subagent extensibility.  The net-snmp
 202   agent can run as both a master agent and a subagent.  Additionally,
 203   a toolkit is provided that enables users of it to easily embed a
 204   agentx client into external applications.  See the tutorial at
 205   http://www.net-snmp.org/tutorial-5/toolkit/ for an example of how
 206   go about doing this.
 207
 208 CONFIGURATION
 209
 210   See the man/snmp.conf.5 manual page.
 211
 212   For the agent, additionally see the man/snmpd.conf.5 manual page.
 213
 214   For the snmptrapd, see the man/snmptrapd.conf.5 manual page.
 215
 216   You can also run the snmpconf perl script to help you create some of
 217   these files.
 218
 219 SUBMITTING BUG REPORTS
 220
 221   Important: *Please* include what version of the net-snmp (or
 222   ucd-snmp) package you are using and what architecture(s) you're
 223   using, as well as detailed information about exactly what is wrong.
 224
 225   To submit a bug report, please use the web interface at
 226   http://www.net-snmp.org/bugs/.  It is a full-fledged
 227   bug-tracking system that will allow you to search for already
 228   existing bug reports as well as track the status of your report as
 229   it is processed by the core developers.
 230
 231   If you intend to submit a patch as well, please read the PORTING
 232   file before you do so and then submit it to
 233   http://www.net-snmp.org/patches/.
 234
 235 CLOSING
 236
 237   We love patches.  Send some to us!  But before you do, please see
 238   the 'PORTING' file for information on helping us out with the
 239   process of integrating your patches (regardless of whether its a new
 240   feature implementation or a new port).
 241
 242   Also, We're interested if anyone actually uses/likes/hates/whatever
 243   this package...  Mail us a note and let us know what you think of it!
 244
 245   Have fun and may it make your life easier,
 246
 247     The net-snmp developers
 248
 249 THANKS
 250
 251   The following people have contributed various patches and
 252   improvements.  To them we owe our deepest thanks (and you do too!):
 253
 254     Wes Hardaker <hardaker@users.sourceforge.net>
 255     Steve Waldbusser <waldbusser@nextbeacon.com>
 256     Dan A. Dickey <ddickey@transition.com>
 257     Dave Shield <D.T.Shield@csc.liv.ac.uk>
 258     Giovanni S. Marzot <gmarzot@nortelnetworks.com>
 259     Niels Baggesen <nba@users.sourceforge.net>
 260     Simon Leinen <simon@limmat.switch.ch>
 261     David T. Perkins <dperkins@dsperkins.com>
 262     Mike Perik <mikep@crt.com>
 263     Sanjai Narain <narain@thumper.bellcore.com>
 264     francus@metsny.delphi.com
 265     Gary Palmer <gpalmer@freebsd.org>
 266     Marc G. Fournier <scrappy@ki.net>
 267     Gary A. Hayward <gah@bellcore.com>
 268     Jennifer Bray <jbray@origin-at.co.uk>
 269     Philip Guenther <guenther@gac.edu>
 270     Elwyn B Davies <edavies@origin-at.co.uk>
 271     Simon Burge <simonb@telstra.com.au>
 272     David Paul Zimmerman <dpz@apple.com>
 273     Alan Batie <batie@aahz.jf.intel.com>
 274     Michael Douglass <mikedoug@texas.net>
 275     Ted Rule <Ted_Rule@FLEXTECH.CO.UK>
 276     Craig Bevins <craigb@bitcom.net.au>
 277     Arther Hyun <arthur@psi.com>
 278     Cristian Estan <Cristian.Estan@net.utcluj.ro>
 279     Eugene Polovnikov <eugen@rd.zgik.zaporizhzhe.ua>
 280     Jakob Ellerstedt <jakob@dynarc.se>
 281     Michael J. Slifcak <slif@bellsouth.net>
 282     Jonas Olsson <jolsson@erv.ericsson.se>
 283     James H. Young <sysjhy@gsu.edu>
 284     Jeff Johnson <jbj@redhat.com>
 285     Markku Laukkanen <marlaukk@stybba.ntc.nokia.com>
 286     Derek Simkowiak <dereks@kd-dev.com>
 287     David F. Newman <dnewman@epnet.com>
 288     Nick Amato <naamato@merit.edu>
 289     Mike Baer <baerm@calweb.com>
 290     Patrick Lawrence <pjlawrence@ucdavis.edu>
 291     Russ Mundy <mundy@tislabs.com>
 292     Olafur Gudmundsson <ogud@tislabs.com>
 293     David Reeder <dreeder@tislabs.com>
 294     Ed Lewis <lewis@tislabs.com>
 295     Bill Babson <wbabson@tislabs.com>
 296     Chris Smith <csmith@platform.com>
 297     Mike Michaud <mikemichaud@earthlink.net>
 298     Andy Hood <ahood@westpac.com.au>
 299     Robert Story <rstory@freesnmp.com>
 300     Bert Driehuis <driehuis@playbeing.org>
 301     Juergen Schoenwaelder <schoenw@ibr.cs.tu-bs.de>
 302     Frank Strauss <strauss@ibr.cs.tu-bs.de>
 303     Ragnar Kjørstad <ucd@ragnark.vestdata.no>
 304     Jochen Kmietsch <jochen.kmietsch@tu-clausthal.de>
 305     Jun-ichiro itojun Hagino <itojun@iijlab.net>
 306     John L Villalovos <john.l.villalovos@intel.com>
 307     Christoph Mammitzsch <Christoph.Mammitzsch@tu-clausthal.de>
 308     Arne Oesleboe <Arne.Oesleboe@item.ntnu.no>
 309     Jeff Cours <jeff@ultradns.com>
 310     Karl Schilke <karl_schilke@eli.net>
 311     John Naylon <jbpn@cambridgebroadband.com>
 312     Ken Hornstein <kenh@cmf.nrl.navy.mil>
 313     Martin Oldfield <m@mail.tc>
 314     Harrie Hazewinkel <harrie@users.sourceforge.net>
 315     Mark Ferlatte <ferlatte@users.sourceforge.net>
 316     Marus Meissner <marcusmeissner@users.sourceforge.net>
 317     Stephan Wenzer <stephanwenzel@users.sourceforge.net>
 318     Ron Mevissen <ron.mevissen@eed.ericsson.se>
 319     T.J. Mather <tjmather@tjmather.com>
 320     Craig Setera <seterajunk@charter.net>
 321     Katsuhisa ABE <abekatsu@cysols.com>
 322     Axel Kittenberger <Axel.Kittenberger@maxxio.com>
 323     Johannes Schmidt-Fischer <jsf@InterFace-AG.com>
 324     Jeffrey Watson <nostaw@users.sourceforge.net>
 325     Bruce Shaw <Bruce.Shaw@gov.ab.ca>
 326     Stefan Radman <sradman@users.sourceforge.net>
 327     Stephen J. Friedl <sjfriedl@users.sourceforge.net>
 328     Alex Burger <alex_b@users.sourceforge.net>
 329     Christophe Varoqui <ext.devoteam.varoqui@sncf.fr>
 330     Srikanth Pindiproli <sripindip@users.sourceforge.net>
 331     Kevin Graham <kevgraham7@users.sourceforge.net>
 332     Xiaofeng Ling <xfling@users.sourceforge.net>
 333     Brandon Knitter <knitterb@bl...>
 334     Andrew Findlay <andrew.findlay@skills-1st.co.uk>
 335     Ron Tabor <rtabor@users.sourceforge.net>
 336     Peter Warasin <drg-r3@users.sourceforge.net>
 337     Bob Rowlands <robert.rowlands@sun.com>
 338     Peter Hicks <Peter.Hicks@POGGS.CO.UK>
 339     Andy Smith <wasmith32@earthlink.net>
 340     Nick Barkas <nbarkas@users.sourceforge.net>
 341     Noah Friedman <friedman@prep.ai.mit.edu>
 342     Geert De Peuter <geert@depeuter.org>
 343     Magnus Fromreide <magfr@lysator.liu.se>
 344     Marcus Meissner <marcusmeissner@users.sourceforge.net>
 345     Andrew Rucker Jones <arjones@users.sourceforge.net>
 346     Dai.H. <dg-f@users.sourceforge.net>
 347     Thomas Anders <tanders@users.sourceforge.net>
 348     Vladislav Bogdanov <slava_reg@nsys.by>
 349     Peter Martin <pnmartin@users.sourceforge.net>
 350     Thomas Lackey <telackey@users.sourceforge.net>
 351     Joe Buehler <jbuehler@spirentcom.com>
 352     Bart Van Assche <bart.vanassche@gmail.com>
 353
 354   We've probably forgotten people on this list.  Let us know if you've
 355   contributed code and we've left you out.