| 1 |
README file for net-snmp Version: 5.9.5.2 |
| 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 |
Web page: |
| 66 |
- http://www.net-snmp.org/ |
| 67 |
Project Wiki: |
| 68 |
- http://www.net-snmp.org/wiki/ |
| 69 |
Sourceforge Project page: |
| 70 |
- http://sourceforge.net/projects/net-snmp |
| 71 |
|
| 72 |
The old ucd-snmp.ucdavis.edu web site and ftp server is now |
| 73 |
offline and should not be accessed any longer. |
| 74 |
|
| 75 |
WEB PAGES |
| 76 |
|
| 77 |
http://www.net-snmp.org/ |
| 78 |
http://sourceforge.net/projects/net-snmp |
| 79 |
http://www.net-snmp.org/wiki/ |
| 80 |
|
| 81 |
INSTALLATION |
| 82 |
|
| 83 |
See the INSTALL file distributed with this package. |
| 84 |
|
| 85 |
COPYING AND COPYRIGHTS |
| 86 |
|
| 87 |
See the COPYING file distributed with this package. |
| 88 |
|
| 89 |
FREQUENTLY ASKED QUESTIONS |
| 90 |
|
| 91 |
See the FAQ file distributed with this package. |
| 92 |
This is also available on the project Wiki at |
| 93 |
|
| 94 |
http://www.net-snmp.org/wiki/index.php/FAQ |
| 95 |
|
| 96 |
so that the wider Net-SNMP community can help maintain it! |
| 97 |
|
| 98 |
HELPING OUT |
| 99 |
|
| 100 |
This is a project worked on by people around the net. We'd love |
| 101 |
your help, but please read the PORTING file first. Also, subscribe |
| 102 |
to the net-snmp-coders list described below and mention what you're |
| 103 |
going to work on to make sure no one else is already doing so! |
| 104 |
You'll also need to keep up to date with the latest code snap shot, |
| 105 |
which can be obtained from CVS using the information found at |
| 106 |
http://www.net-snmp.org/cvs/. |
| 107 |
|
| 108 |
Contributions to the Net-SNMP source code in any form are greatly |
| 109 |
appreciated. We expect the parties providing such contributions to |
| 110 |
have the right to contribute them to the Net-SNMP project or that |
| 111 |
the parties that do have the right have directed the person |
| 112 |
submitting the contribution to do so. In addition, all contributors |
| 113 |
need to be aware that if the contribution is accepted and |
| 114 |
incorporated into the Net-SNMP project, it will be redistributed |
| 115 |
under the terms of the license agreement used for the entire body of |
| 116 |
work that comprises the Net-SNMP project (see the COPYING file for |
| 117 |
details). If this license agreement ever changes the contribution |
| 118 |
will continue to be released under any new licenses as well. Thank |
| 119 |
you, in advance, for your gracious contributions. |
| 120 |
|
| 121 |
CODE UPDATE ANNOUNCEMENTS |
| 122 |
|
| 123 |
See the NEWS file and the ChangeLog file for details on what has |
| 124 |
changed between releases. |
| 125 |
|
| 126 |
We hate broadcasting announce messages to other mailing lists and |
| 127 |
newsgroups, so there is a mailing list set up to handle release |
| 128 |
announcements. Any time we put new software out for ftp, we'll mail |
| 129 |
this fact to [email protected]. See the |
| 130 |
MAILING LISTS section described below to sign up for these |
| 131 |
announcements. |
| 132 |
|
| 133 |
We will post new announcements on a very infrequent basis to the |
| 134 |
other channels (the other snmp mailing lists and newsgroups like |
| 135 |
comp.protocols.snmp), but only for major code revisions and not for |
| 136 |
bug-fix patches or small feature upgrades. |
| 137 |
|
| 138 |
MAILING LISTS |
| 139 |
|
| 140 |
The lists: |
| 141 |
|
| 142 |
A number of mailing lists have been created for support of the project: |
| 143 |
The main ones are: |
| 144 |
|
| 145 |
[email protected] -- For official announcements |
| 146 |
[email protected] -- For usage discussions |
| 147 |
[email protected] -- For development discussions |
| 148 |
|
| 149 |
The -coders list is intended for discussion on development of code |
| 150 |
that will be shipped as part of the package. The -users list is |
| 151 |
for general discussion on configuring and using the package, |
| 152 |
including issues with coding user-developed applications (clients, |
| 153 |
managers, MIB modules, etc). |
| 154 |
|
| 155 |
Please do *NOT* send messages to both -users and -coders lists. |
| 156 |
This is completely unnecessary, and simply serves to further |
| 157 |
overload (and annoy) the core development team. If in doubt, |
| 158 |
just use the -users list. |
| 159 |
|
| 160 |
|
| 161 |
The other lists of possible interest are: |
| 162 |
|
| 163 |
[email protected] -- For cvs update announcements |
| 164 |
[email protected] -- For Bug database update announcements |
| 165 |
[email protected] -- For Patch database update announcements |
| 166 |
|
| 167 |
Please do NOT post messages to these lists (or to the announce list above). |
| 168 |
Bug reports and Patches should be submitted via the Source Forge tracker |
| 169 |
system. See the main project web pages for details. |
| 170 |
|
| 171 |
To subscribe to any of these lists, please see: |
| 172 |
|
| 173 |
http://www.net-snmp.org/lists/ |
| 174 |
|
| 175 |
|
| 176 |
Archives: |
| 177 |
The archives for these mailing lists can be found by following links at |
| 178 |
|
| 179 |
http://www.net-snmp.org/lists/ |
| 180 |
|
| 181 |
AGENT EXTENSIBILITY |
| 182 |
|
| 183 |
The agent that comes with this package is extensible through use of |
| 184 |
shell scripts and other methods. See the configuration manual pages |
| 185 |
(like snmpd.conf) and run the snmpconf perl script for further details. |
| 186 |
|
| 187 |
You can also extend the agent by writing C code directly. The agent |
| 188 |
is extremely modular in nature and you need only create new files, |
| 189 |
re-run configure and re-compile (or link against its libraries). No |
| 190 |
modification of the distributed source files are necessary. See the |
| 191 |
following files for details on how to go about this: |
| 192 |
http://www.net-snmp.org/tutorial-5/toolkit/, |
| 193 |
agent/mibgroup/examples/*.c |
| 194 |
|
| 195 |
Also, see the local/mib2c program and its README file for help in |
| 196 |
turning a textual mib description into a C code template. |
| 197 |
|
| 198 |
We now support AgentX for subagent extensibility. The net-snmp |
| 199 |
agent can run as both a master agent and a subagent. Additionally, |
| 200 |
a toolkit is provided that enables users of it to easily embed a |
| 201 |
agentx client into external applications. See the tutorial at |
| 202 |
http://www.net-snmp.org/tutorial-5/toolkit/ for an example of how |
| 203 |
go about doing this. |
| 204 |
|
| 205 |
CONFIGURATION |
| 206 |
|
| 207 |
See the man/snmp.conf.5 manual page. |
| 208 |
|
| 209 |
For the agent, additionally see the man/snmpd.conf.5 manual page. |
| 210 |
|
| 211 |
For the snmptrapd, see the man/snmptrapd.conf.5 manual page. |
| 212 |
|
| 213 |
You can also run the snmpconf perl script to help you create some of |
| 214 |
these files. |
| 215 |
|
| 216 |
SUBMITTING BUG REPORTS |
| 217 |
|
| 218 |
Important: *Please* include what version of the net-snmp (or |
| 219 |
ucd-snmp) package you are using and what architecture(s) you're |
| 220 |
using, as well as detailed information about exactly what is wrong. |
| 221 |
|
| 222 |
To submit a bug report, please use the web interface at |
| 223 |
http://www.net-snmp.org/bugs/. It is a full-fledged |
| 224 |
bug-tracking system that will allow you to search for already |
| 225 |
existing bug reports as well as track the status of your report as |
| 226 |
it is processed by the core developers. |
| 227 |
|
| 228 |
If you intend to submit a patch as well, please read the PORTING |
| 229 |
file before you do so and then submit it to |
| 230 |
http://www.net-snmp.org/patches/. |
| 231 |
|
| 232 |
CLOSING |
| 233 |
|
| 234 |
We love patches. Send some to us! But before you do, please see |
| 235 |
the 'PORTING' file for information on helping us out with the |
| 236 |
process of integrating your patches (regardless of whether its a new |
| 237 |
feature implementation or a new port). |
| 238 |
|
| 239 |
Also, We're interested if anyone actually uses/likes/hates/whatever |
| 240 |
this package... Mail us a note and let us know what you think of it! |
| 241 |
|
| 242 |
Have fun and may it make your life easier, |
| 243 |
|
| 244 |
The net-snmp developers |
| 245 |
|
| 246 |
THANKS |
| 247 |
|
| 248 |
This project has been graciously supported by a long list of people |
| 249 |
(too long to keep roperly up to date). To them we owe our deepest |
| 250 |
thanks (and you do too!). Please see the git log or ChangeLog file, |
| 251 |
where the core developers are careful to have (hopefully always) |
| 252 |
pointed out where patches have come from. |