ACE/ASNMP/README

   1 ====================================================================
   2 ASNMP = ACE+SNMP++ Version 2.1
   3 By Michael R. MacFaden mrm@acm.org, mrm@yagosys.com
   4 ====================================================================
   5
   6 What is ASNMP ? ==> ACE+SNMP! aka Another SNMP API
   7   HP's SNMP++ 2.5 freely available C++ SNMP class library
   8   has been adapted to the ACE 4.2 Framework.
   9
  10 What is Simple Network Management Protocol(SNMP)?
  11   See the FAQ:
  12   http://www.snmp.com/FAQs/snmp-faq-part1.txt
  13   http://www.snmp.com/FAQs/snmp-faq-part2.txt
  14
  15 What was changed from HP version?
  16   See src/ChangeLog file.
  17
  18 Is HP SNMP++ compatible with ASNMP?
  19   It is neither source nor binary compatible. About 10% of the API has changed.
  20   There have been API changes to make the interface more orthogonal
  21   and to reduce implementation complexity such as consolidating constructors
  22   with default formal values, and to remove some inconsistencies
  23   with the HP interface as well as locking down valid() semantics, etc.
  24
  25 What platforms have the test programs been verified on?
  26   Linux/GCC fixes are now in as well.
  27
  28 Why use this version?
  29   The SNMP++ version ships only for HP-UX and for Windows.
  30   It is not very portable nor does it do a good job at checking
  31   for out of memory exhaustion conditions (asn1.cpp). There is some great
  32   code here. ACE needs an SNMP library to build NM type
  33   communications applications. Hence ASNMP was born in my spare time.
  34
  35 How does ASNMP differ from SNMP?
  36   Current version uses ACE OS Adaption layer.  All memory
  37   allocation is now consistent, uses ACE_NEW().
  38   Standard ACE Debugging (ACE_TRACE) has been inserted.
  39   ASNMP has less global namespace pollution by moving all non-class
  40   functions into interface classes or made into static locals.
  41
  42   An agent intefarce has been added (asnmp/sagent.h) so both agents
  43   and managers can use this class library. A trivial agent
  44   exists in ASNMP/agent/
  45
  46   X11 GUI support removed from this version since this is
  47   not the place to include GUI support in the new world of
  48   multi-threaded apps.
  49
  50   The async interface does not match the HP implementation.
  51
  52 How to build this library
  53   Set ACE_ROOT and platform_macros.GNU per ../INSTALL file.
  54   create libasnmp.a, libasnmp.so and then run the tests
  55
  56 Any Support for ASNMP?
  57    As time permits through github.
  58
  59 Where to ask questions?
  60   Please use github issues or discussions at https://github.com/DOCGroup/ACE_TAO
  61   or mrm@acm.org
  62
  63 NOTE: Please do not bother Eric Mellquist unless you are using
  64    the original HP version of this library.
  65
  66 Where can I get the original HP SNMP++?
  67    From ftp://rosegarden.external.hp.com:/pub/snmp++
  68
  69 What version of SNMP is fully supported?
  70   SNMP Version 1 (RFC 1155,1157, 1215)
  71
  72 What about SNMP Version 2c?
  73   V2c is defined in RFC 1901 - 1908
  74   These bits are added to v1 code in this library: GetBulk PDU, Counter64
  75   These bits are missing Inform (RFC 1905)
  76   RFC 1903 defined new datatypes using existing SMI via macros.
  77   These should be coded as if they were SMI datatypes to encapsulate
  78   their behavior. V2c hasn't been deployed
  79
  80 What about SNMP Version 3?
  81    It is looking good for V3, but so far, we're just watching.
  82    http://www.ietf.org/html.charters/snmpv3-charter.html
  83    A C implemenation is now available from UC Davis.
  84
  85 What copyrights/legal requirements are required when using this code?
  86   See ./COPYRIGHT
  87
  88 Does this really work?
  89   See tests/ directory  for the current test reports (purify/purecov/...).
  90
  91 How does one Extend an SNMP Agent?
  92   Extending an agent typically means updating the agent source or
  93   using a dynamic link style API. RFC 2257 (AgentX) is the current design
  94   for doing this in a standard way. This hasn't been well formalized yet
  95   so extending an existing agent is still a vendor API thing.
  96
  97   The agent provided here is a template. A mib compiler and agent
  98   library typically provide better agent support. See the UC-Davis
  99   SNMP software for an example Agent that is portable and can report
 100   on many flavors of UNIX and Windows.
 101
 102 Any Future Plans?
 103   The ASNMP library will be improved for performance and made to use
 104   higher level design patterns. Hopefully it will be used as a
 105   vehicle for grad students to learn something about network mgmt
 106   code work a related cousin of general distributed programming.
 107
 108
 109 Regards,
 110 Michael R. MacFaden
 111 Member of the Technical Staff
 112 Cabletron Systems, Inc.
 113 215 Moffet Park Drive
 114 Sunnyvale, CA 94089
 115 mrm@yagosys.com
 116 http://www.yagosys.com
 117
 118 ====================================================================
 119 SNMP++ For UNIX Source Code and Examples:
 120 ====================================================================
 121 Included within this package can be found the source code and
 122 examples for SNMP++. The following represents the directories which
 123 are included within the compressed tar file and their contents.
 124
 125 For more details on the API , please refer to the API specification.
 126
 127 This library is a complete implementation of SNMP++ and does not
 128 require other SNMP libraries to be present.
 129
 130 Required Tools:
 131 ---------------------------------------------------------------------
 132
 133
 134 readme.txt ( this file)
 135 |
 136 |
 137 |------ src ( .cpp files and Makefile for building libraries )
 138 |
 139 |------ examples ( a variety of apps, .cpp and Makefile included )
 140 |
 141 |------ tests - unit test routines
 142
 143
 144 src Directory Contents:
 145 --------------------------------------------------------------------
 146 Makefile             - make file for ACE. build
 147 target.cpp           - Collection of attributes(address, timeout, etc) used
 148                        to define a command session
 149 snmp.cpp             - A logical session between NM app and agent
 150 pdu.cpp              - Pdu class source (vb list and API command)
 151 wpdu.cpp             - Adapter pattern based class between CMU and HP code
 152 transaction.cpp      - synchronous transaction clss
 153 vb.cpp               - Variable Binding class source (oid + value)
 154
 155 << SMI datatypes used to get/set values in SNMPv1 agents >>
 156
 157 address.cpp          - Address class source
 158 gauge.cpp            - Gauge32 class source
 159 integer.cpp          - Integer32 class source
 160 counter.cpp          - Counter32 class source
 161 ctr64.cpp            - Counter64 class source
 162 timetick.cpp         - TimeTicks class source
 163 octet.cpp            - Octet String class source
 164 oid.cpp              - Oid class source
 165 asn1.cpp             - ASN1 encoding and decoding code. CMU code.
 166
 167 examples Directory Contents:
 168 ---------------------------------------------------------------------
 169 Makefile             - make file for building console apps
 170 get.cpp          - source for SNMP get program
 171 next.cpp         - source for SNMP get Next program
 172 set.cpp          - source for SNMP set program
 173 trap.cpp         - source for SNMP trap send program
 174 walk.cpp         - source for SNMP walk program
 175