135/snmp-info
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

prep for 2.04 release

Browse Source
This commit is contained in:
Oliver Gorwits
2011-03-31 08:34:57 +00:00
parent d09e5de229
commit bc8c8a6061
81 changed files with 104 additions and 119 deletions
Download Patch File Download Diff File Expand all files Collapse all files

58
README
View File

@@ -1,14 +1,11 @@
NAME
SNMP::Info - Object Oriented Perl5 Interface to Network devices and MIBs
through SNMP.
VERSION
SNMP::Info - Version 2.02
SNMP::Info - Version 2.04
AUTHOR
SNMP::Info is maintained by team of Open Source authors headed by Eric
Miller, Bill Fenner, Max Baker and Jeroen van Ingen.
@@ -19,12 +16,10 @@ AUTHOR
<http://netdisco.org> by Max Baker.
DEVICES SUPPORTED
See <http://netdisco.org/doc/DeviceMatrix.html> or DeviceMatrix.txt for
more details.
SYNOPSIS
use SNMP::Info;
my $info = new SNMP::Info(
@@ -80,13 +75,11 @@ SYNOPSIS
}
SUPPORT
Please direct all support, help, and bug requests to the snmp-info-users
Mailing List at
<http://lists.sourceforge.net/lists/listinfo/snmp-info-users>.
DESCRIPTION
SNMP::Info gives an object oriented interface to information obtained
through SNMP.
@@ -113,7 +106,6 @@ DESCRIPTION
a couple hashes. See EXTENDING SNMP::INFO.
REQUIREMENTS
1. Net-SNMP
To use this module, you must have Net-SNMP installed on your system.
More specifically you need the Perl modules that come with it.
@@ -151,14 +143,15 @@ REQUIREMENTS
directory and that the MIBs are world-readable.
DESIGN GOALS
1. Use of textual MIB leaf identifier and enumerated values
* All values are retrieved via MIB Leaf node names
* All values are retrieved via MIB Leaf node names
For example SNMP::Info has an entry in its %GLOBALS hash for
``sysName'' instead of 1.3.6.1.2.1.1.5.
* Data returned is in the enumerated value form.
* Data returned is in the enumerated value form.
For Example instead of looking up 1.3.6.1.2.1.2.2.1.3 and
getting back 23
@@ -179,14 +172,12 @@ DESIGN GOALS
inclusion in the next version.
SUBCLASSES
These are the subclasses that implement MIBs and support devices:
Required MIBs not included in the install instructions above are noted
here.
MIB Subclasses
These subclasses implement method to access one or more MIBs. These are
not used directly, but rather inherited from device subclasses.
@@ -283,6 +274,13 @@ SUBCLASSES
See documentation in SNMP::Info::FDP for details.
SNMP::Info::IPv6
SNMP Interface for obtaining configured IPv6 addresses and mapping
IPv6 addresses to MACs and interfaces, using information from
IP-MIB, IPV6-MIB and/or CISCO-IETF-IP-MIB.
See documentation in SNMP::Info::IPv6 for details.
SNMP::Info::IEEE802dot11
IEEE802dot11-MIB. A collection of OIDs providing information about
standards based 802.11 wireless devices.
@@ -325,7 +323,6 @@ SUBCLASSES
See documentation in SNMP::Info::SONMP for details.
Device Subclasses
These subclasses inherit from one or more classes to provide a common
interface to data obtainable from network devices.
@@ -613,6 +610,11 @@ SUBCLASSES
See documentation in SNMP::Info::Layer3::Passport for details.
SNMP::Info::Layer3::Pf
Subclass for FreeBSD-Based Firewalls using Pf /Pf Sense
See documentation in SNMP::Info::Layer3::Pf for details.
SNMP::Info::Layer3::Sun
Subclass for Generic Sun Routers running SunOS.
@@ -624,7 +626,6 @@ SUBCLASSES
See documentation in SNMP::Info::Layer3::Timetra for details.
Thanks
Thanks for testing and coding help (in no particular order) to :
Alexander Barthel, Andy Ford, Alexander Hartmaier, Andrew Herrick, Alex
Kramarov, Bernhard Augenstein, Bradley Baetz, Brian Chow, Brian Wilson,
@@ -635,9 +636,7 @@ Thanks
Netdisco README!
USAGE
Constructor
new()
Creates a new object and connects via SNMP::Session.
@@ -760,7 +759,6 @@ USAGE
identify the device.
Data is Cached
Methods and subroutines requesting data from a device will only load the
data once, and then return cached versions of that data.
@@ -771,7 +769,6 @@ USAGE
globals and table methods.
Object Scalar Methods
These are for package related data, not directly supplied from SNMP.
$info->clear_cache()
@@ -848,7 +845,6 @@ USAGE
Indexing.html>
Globals (Scalar Methods)
These are methods to return scalar data from RFC1213.
Some subset of these is probably available for any network device that
@@ -897,7 +893,6 @@ USAGE
("ipForwarding")
Table Methods
Each of these methods returns a hash_reference to a hash keyed on the
interface index in SNMP.
@@ -912,7 +907,6 @@ USAGE
cases changes between reboots of the network device.
Partial Table Fetches
If you want to get only a part of an SNMP table or a single instance
from the table and you know the IID for the part of the table that you
want, you can specify it in the call:
@@ -927,7 +921,6 @@ USAGE
Partial table results are not cached.
Interface Information
$info->interfaces()
This methods is overridden in each subclass to provide a mapping
between the Interface Table Index (iid) and the physical port name.
@@ -1018,7 +1011,6 @@ USAGE
("ifAlias")
Interface Statistics
$info->i_octet_in(), $info->i_octets_out(), $info->i_octet_in64(),
$info->i_octets_out64()
Bandwidth.
@@ -1109,7 +1101,6 @@ USAGE
("ifSpecific")
IP Address Table
Each entry in this table is an IP address in use on this device. Usually
this is implemented in Layer3 Devices.
@@ -1134,7 +1125,6 @@ USAGE
("ipAdEntBcastAddr")
IP Routing Table
$info->ipr_route()
The route in question. A value of 0.0.0.0 is the default gateway
route.
@@ -1186,6 +1176,7 @@ USAGE
-- route to a non-local
indirect(4) -- host/network/sub-network
"The type of route. Note that the values
direct(3) and indirect(4) refer to the notion of
direct and indirect routing in the IP
@@ -1250,7 +1241,6 @@ USAGE
("ipRouteInfo")
SETTING DATA VIA SNMP
This section explains how to use SNMP::Info to do SNMP Set operations.
$info->set_METHOD($value)
@@ -1280,7 +1270,6 @@ SETTING DATA VIA SNMP
subroutines will need to be added if they haven't been already.
Quiet Mode
SNMP::Info will not chirp anything to STDOUT unless there is a serious
error (in which case it will probably die).
@@ -1295,9 +1284,7 @@ Quiet Mode
my $name = $info->name() or die "Couldn't get sysName!" . $name->error();
EXTENDING SNMP::INFO
Data Structures required in new Subclass
A class inheriting this class must implement these data structures :
$INIT
@@ -1354,7 +1341,6 @@ EXTENDING SNMP::INFO
)
Sample Subclass
Let's make a sample Layer 2 Device subclass. This class will inherit the
Cisco Vlan module as an example.
@@ -1398,6 +1384,7 @@ EXTENDING SNMP::INFO
'super_hero_powers' => 'SuperHeroIfPowers'
);
%MUNGE = (%SNMP::Info::Layer2::MUNGE,
%SNMP::Info::CiscoVTP::MUNGE,
'super_hero_powers' => \&munge_powers
@@ -1446,9 +1433,7 @@ EXTENDING SNMP::INFO
of SNMP::Info.
SNMP::INFO INTERNALS
Object Namespace
Internal data is stored with bareword keys. For example $info->{debug}
SNMP Data is stored or marked cached with keys starting with an
@@ -1458,7 +1443,6 @@ SNMP::INFO INTERNALS
above.
Package Globals
These set the default value for an object upon creation.
$DEBUG
@@ -1480,7 +1464,6 @@ SNMP::INFO INTERNALS
for more info. Can change by passing BulkRepeaters option in new()
Data Munging Callback Subroutines
munge_speed()
Makes human friendly speed ratings using %SPEED_MAP
@@ -1576,7 +1559,6 @@ SNMP::INFO INTERNALS
Takes an OID and return the object name if the right MIB is loaded.
Internally Used Functions
$info->init()
Used internally. Loads all entries in %MIBS.
@@ -1707,7 +1689,6 @@ SNMP::INFO INTERNALS
packed bitmask
AUTOLOAD
Each entry in either %FUNCS, %GLOBALS, or MIB Leaf node names present in
loaded MIBs are used by AUTOLOAD() to create dynamic methods.
@@ -1737,7 +1718,6 @@ SNMP::INFO INTERNALS
subclass.
COPYRIGHT AND LICENSE
Changes from SNMP::Info Version 0.7 and on are: Copyright (c) 2003-2010
Max Baker and SNMP::Info Developers All rights reserved.