= SNMP4JR - SNMP Library for JRuby

== Summary

SNMP4JR is both a wrapper for SNMP4J and a library unto itself. I've noticed that many of the JRuby libs seem to be simple wrappers, but interpreted languages usually have easier interfaces to things like SNMP(SNMP for PHP for instance, and the ruby SNMP libs). To understand the differences between this library and the pure ruby SNMP libs please see the SNMP4J website or the feature list below:

=== Features:

Wrappers written in Ruby with ease of use in mind.
Very high performance
Thread safe
Simple interface(SNMPMulti) for polling multiple devices with an OID list or hand crafted PDU
Full access to SNMP4J API functionality

=== SNMP4J API Features:

SNMPv3 with MD5 and SHA authentication and DES and AES 128, AES 192, and AES 256 privacy.
Pluggable Message Processing Models with implementations for MPv1, MPv2c, and MPv3
All PDU types.
Pluggable transport mappings. UDP and TCP are supported out-of-the-box.
Pluggable timeout model.
Synchronous and asynchronous requests.
Command generator as well as command responder support.
Free open source with the Apache license model
Java™ 1.4.1 or later
Logging based on Log4J
Row-based efficient asynchronous table retrieval with GETBULK.
Multi-threading support.
JUnit tests (will be available in version 2.x and later)

=== Usage: Wrappers are provided for all API calls for SNMP4J. Use them as you would use the Java libs directly. Please refer to SNMP4J documentation for further direction.

SNMPTarget Utility class usage:

target = SNMPTarget.new(:host => 'localhost', :community => 'public')
target.get_bulk ['1.3.6.1.2.1.1.1', '1.3.6.1.2.1.1.3']
puts target.result_to_s

# bulk walk (defaults to version 2c bulk walk, but will do v1 if version is set)
target.walk('1.3.6.1.2.1.1') # System mib
puts target.result_to_s

# helper functions have been added for common mibs: system, processes, resources, 
# interfaces, ifX, full_interfaces, and volumes
target.walk_system  # System walk helper, same as above
puts target.result_to_s

# you can set too, just make sure you specify the r/w string as the :community
target = SNMPTarget.new(:host => '127.0.0.1', :community => 'private')
# you need to pass in the SMI encoded option here
# Available SMI classes are:
# AbstractVariable, BitString, Counter32, Counter64, Gauge32, GenericAddress, Integer32, 
# IpAddress, Null, OctetString, OID, Opaque, SMIAddress, TcpAddress, TimeTicks, 
# TransportIpAddress, UdpAddress, UnsignedInteger32, VariantVariable
email = SNMP4JR::SMI::OctetString.new('mark.cotner@gmail.com')
target.set('1.3.6.1.2.1.1.4.0', email).to_s

Please see the wiki and examples directory for more examples: http://wiki.github.com/awksedgreep/SNMP4JR/

=== Notes:

Currently only supports the API, but agent support could be added. If you would like to implement an agent in JRuby please let me know and I'll try to add it. Please specify if you would like to implement an agent or AgentX as these are two different things.
If you would like commercial support for SNMP4J. Please see this page Support:http://www.snmp4j.org/html/support.html PLEASE NOTE that this is NOT a support mechanism for this gem, but for the library it wraps. For gem support see the github repository at: http://github.com/awksedgreep/SNMP4JR
SNMP4J is included with this gem and is released with an Apache 2.0 license which can be found here: http://www.snmp4j.org/LICENSE-2_0.txt
```
                           Apache License
                     Version 2.0, January 2004
                  http://www.apache.org/licenses/
```
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
  
  "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document.
  
  "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.
  
  "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.
  
  "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License.
  
  "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files.
  
  "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types.
  
  "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below).
  
  "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof.
  
  "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution."
  
  "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions:
  
  (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and
  
  (b) You must cause any modified files to carry prominent notices stating that You changed the files; and
  
  (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and
  
  (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices n

SNMP4JR

Install / Use

README