bruce roger's foundry changes

Info/FDP.pm

@@ -0,0 +1,397 @@
+# SNMP::Info::FDP
+# Bruce Rodger
+# $Id$
+#
+# (c) 2004 Bruce Rodger, Max Baker 
+# All rights reserved.  
+#
+# Copyright (c) 2002,2003 Regents of the University of California
+# All rights reserved.
+# 
+# Redistribution and use in source and binary forms, with or without 
+# modification, are permitted provided that the following conditions are met:
+# 
+#     * Redistributions of source code must retain the above copyright notice,
+#       this list of conditions and the following disclaimer.
+#     * Redistributions in binary form must reproduce the above copyright notice,
+#       this list of conditions and the following disclaimer in the documentation
+#       and/or other materials provided with the distribution.
+#     * Neither the name of the University of California, Santa Cruz nor the 
+#       names of its contributors may be used to endorse or promote products 
+#       derived from this software without specific prior written permission.
+# 
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 
+# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+# ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 
+# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+# ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 
+# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 
+# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+package SNMP::Info::FDP;
+$VERSION = 0.9;
+
+use strict;
+
+use Exporter;
+use SNMP::Info;
+use Carp;
+
+@SNMP::Info::FDP::ISA = qw/SNMP::Info Exporter/;
+@SNMP::Info::FDP::EXPORT_OK = qw//;
+
+use vars qw/$VERSION $DEBUG %FUNCS %GLOBALS %MIBS %MUNGE $INIT/;
+# Debug
+$DEBUG=1;
+$SNMP::debugging=$DEBUG;
+
+# Five data structures required by SNMP::Info
+$INIT = 0;
+%MIBS 	= ( 'FOUNDRY-SN-SWITCH-GROUP-MIB' => 'snFdpGlobalRun' );
+
+# Notice we dont inherit the default GLOBALS and FUNCS
+# only the default MUNGE.
+%GLOBALS = (
+            # CDP-Compatibility
+            'cdp_run'      => 'snFdpGlobalRun',
+            'cdp_interval' => 'snFdpGlobalMessageInterval',
+            'cdp_holdtime' => 'snFdpGlobalHoldTime',
+            'cdp_id'       => 'snFdpGlobalDeviceId',
+            #
+            'fdp_run'      => 'snFdpGlobalRun',
+            'fdp_interval' => 'snFdpGlobalMessageInterval',
+            'fdp_holdtime' => 'snFdpGlobalHoldTime',
+            'fdp_id'       => 'snFdpGlobalDeviceId',
+           );
+
+%FUNCS  = (
+            'c_index'        => 'snFdpCacheIfIndex',
+            'c_proto'        => 'snFdpCacheAddressType',
+            'c_ip'           => 'snFdpCacheAddress',
+            'c_ver'          => 'snFdpCacheVersion',
+            'c_id'           => 'snFdpCacheDeviceId',
+            'c_port'         => 'snFdpCacheDevicePort',
+            'c_platform'     => 'snFdpCachePlatform',
+            'c_capabilities' => 'snFdpCacheCapabilities',
+            'c_domain'       => 'snFdpCacheVTPMgmtDomain',
+            'c_vlan'         => 'snFdpCacheNativeVLAN',
+            'c_duplex'       => 'snFdpCacheDuplex'
+          );
+
+%MUNGE = (
+          'c_capabilities' => \&munge_caps,
+          'c_ip'           => \&SNMP::Info::munge_ip
+         );
+
+
+sub munge_caps {
+    my $caps = shift;
+    return undef unless defined $caps;
+
+    my $bits = substr(unpack("B*",$caps),-7);
+    return $bits;
+    
+    
+}
+sub hasFDP {
+    my $fdp = shift;
+
+    my $ver = $fdp->{_version};
+    #my $ver = $fdp->fdp_ver;
+
+
+
+    # SNMP v1 clients dont have the globals
+    if (defined $ver and $ver == 1){
+        my $fdp_ip = $fdp->fdp_ip();
+        # See if anything in fdp cache, if so we have fdp
+        return 1 if (defined $fdp_ip and scalar(keys %$fdp_ip)) ;
+        return undef;
+    }
+    
+    return $fdp->fdp_run();
+}
+
+sub c_if {
+    my $fdp  = shift;
+
+
+
+    # See if by some miracle Cisco implemented the fdpCacheIfIndex entry
+    my $fdp_index     = $fdp->fdp_index();
+    return $fdp_index if defined $fdp_index;
+
+    # Nope, didn't think so. Now we fake it.
+    my $fdp_ip = $fdp->c_ip();
+    unless (defined $fdp_ip){
+        $fdp->{error} = "SNMP::Info::FDP:fdp_if() - Device doesn't have fdp_ip() data.  Can't fake fdp_index()";
+        $DEBUG and carp($fdp->error(1));
+        return undef;
+    }
+
+    my %fdp_if;
+    foreach my $key (keys %$fdp_ip){
+      next unless defined $key;
+      my $iid = $key;
+      # Truncate .1 from fdp cache entry
+      $iid =~ s/\.\d+$//;
+      $fdp_if{$key} = $iid;
+    }
+
+    return \%fdp_if;
+}
+
+1;
+__END__
+
+=head1 NAME
+
+SNMP::Info::FDP - Perl5 Interface to Foundry Discovery Protocol (FDP) using SNMP
+
+=head1 AUTHOR
+
+Max Baker (C<max@warped.org>)
+
+=head1 SYNOPSIS
+
+ my $fdp = new SNMP::Info ( 
+                             AutoSpecify => 1,
+                             Debug       => 1,
+                             DestHost    => 'router', 
+                             Community   => 'public',
+                             Version     => 2
+                           );
+
+ my $class = $fdp->class();
+ print " Using device sub class : $class\n";
+
+ $hasfdp   = $fdp->hasFDP() ? 'yes' : 'no';
+
+ # Print out a map of device ports with FDP neighbors:
+ my $interfaces = $fdp->interfaces();
+ my $fdp_if       = $fdp->fdp_if();
+ my $fdp_ip       = $fdp->fdp_ip();
+ my $fdp_port     = $fdp->fdp_port();
+
+ foreach my $fdp_key (keys %$fdp_ip){
+    my $iid           = $fdp_if->{$fdp_key};
+    my $port          = $interfaces->{$iid};
+    my $neighbor      = $fdp_ip->{$fdp_key};
+    my $neighbor_port = $fdp_port->{$fdp_key};
+    print "Port : $port connected to $neighbor / $neighbor_port\n";
+ }
+
+=head1 DESCRIPTION
+
+SNMP::Info::FDP is a subclass of SNMP::Info that provides an object oriented 
+interface to FDP information through SNMP.
+
+FDP is a Layer 2 protocol that supplies topology information of
+devices that also speak FDP, mostly switches and routers.  It has
+similar functionality to Cisco's CDP, and the SNMP interface is
+virtually identical.  FDP is implemented in Foundry devices, including
+the Bigiron and Fastiron range.
+
+Create or use a device subclass that inherits this class.  Do not use directly.
+
+Each device implements a subset of the global and cache entries. 
+Check the return value to see if that data is held by the device.
+
+=head2 Inherited Classes
+
+None.
+
+=head2 Required MIBs
+
+=over
+
+=item FOUNDRY-SN-SWITCH-GROUP-MIB
+
+Needs a reasonably recent MIB. Works OK with B2R07604A.mib, but doesn't
+work with B2R07600C. 
+
+
+=back
+
+MIBs are normally distributed with each code update. Contact your vendor,
+or trawl through google...
+
+=head1 GLOBAL METHODS
+
+These are methods that return scalar values from SNMP
+
+=over
+
+=item  $fdp->hasFDP()
+
+Is FDP is active in this device?  
+
+Accounts for SNMP version 1 devices which may have FDP but not fdp_run()
+
+=item $fdp->fdp_run()
+
+Is FDP enabled on this device?  
+
+(B<fdpGlobalRun>)
+
+=item $fdp->fdp_interval()
+
+Interval in seconds at which FDP messages are generated.
+
+(B<fdpGlobalMessageInterval>)
+
+=item $fdp->fdp_holdtime()
+
+Time in seconds that FDP messages are kept. 
+
+(B<fdpGlobalHoldTime>)
+
+=item  $fdp->fdp_id() 
+
+Returns FDP device ID.  
+
+This is the device id broadcast via FDP to other devices, and is what is retrieved from remote devices with $fdp->id().
+
+(B<fdpGlobalDeviceId>)
+
+=back
+
+=head1 TABLE METHODS
+
+These are methods that return tables of information in the form of a reference
+to a hash.
+
+=head2 FDP CACHE ENTRIES
+
+=over
+
+=item $fdp->fdp_capabilities()
+
+Returns Device Functional Capabilities.  Results are munged into an ascii
+binary string, 7 digits long, MSB.  Each digit represents a bit from the
+table below.
+
+From L<http://www.cisco.com/univercd/cc/td/doc/product/lan/trsrb/frames.htm#18843>:
+
+(Bit) - Description
+
+=over
+
+=item (0x40) - Provides level 1 functionality.
+
+=item (0x20) - The bridge or switch does not forward IGMP Report packets on nonrouter ports.
+
+=item (0x10) - Sends and receives packets for at least one network layer protocol. If the device is routing the protocol, this bit should not be set.
+
+=item (0x08) - Performs level 2 switching. The difference between this bit and bit 0x02 is that a switch does not run the Spanning-Tree Protocol. This device is assumed to be deployed in a physical loop-free topology.
+
+=item (0x04) - Performs level 2 source-route bridging. A source-route bridge would set both this bit and bit 0x02.
+
+=item (0x02) - Performs level 2 transparent bridging.
+
+=item (0x01) - Performs level 3 routing for at least one network layer protocol.
+
+=back
+
+Thanks to Martin Lorensen C<martin -at- lorensen.dk> for a pointer to this information.
+
+(B<fdpCacheCapabilities>)
+
+=item $fdp->fdp_domain()
+
+The CDP version of this returns remote VTP Management Domain as defined in CISCO-VTP-MIB::managementDomainName
+
+(B<fdpCacheVTPMgmtDomain>)
+
+=item $fdp->fdp_duplex() 
+
+Returns the port duplex status from remote devices.
+
+(B<fdpCacheDuplex>)
+
+=item $fdp->fdp_id()
+
+Returns remote device id string
+
+(B<fdpCacheDeviceId>)
+
+=item $fdp->fdp_if()
+
+Returns the mapping to the SNMP Interface Table.
+
+Note that a lot devices don't implement $fdp->fdp_index(),  So if it isn't around,
+we fake it. 
+
+In order to map the fdp table entry back to the interfaces() entry, we truncate the last number
+off of it :
+
+  # it exists, yay.
+  my $fdp_index     = $device->fdp_index();
+  return $fdp_index if defined $fdp_index;
+
+  # if not, let's fake it
+  my $fdp_ip       = $device->fdp_ip();
+    
+  my %fdp_if
+  foreach my $key (keys %$fdp_ip){
+      $iid = $key;
+      ## Truncate off .1 from fdp response
+      $iid =~ s/\.\d+$//;
+      $fdp_if{$key} = $iid;
+  }
+ 
+  return \%fdp_if;
+
+
+=item $fdp->fdp_index()
+
+Returns the mapping to the SNMP2 Interface table for FDP Cache Entries. 
+
+Most devices don't implement this, so you probably want to use $fdp->fdp_if() instead.
+
+See fdp_if() entry.
+
+(B<fdpCacheIfIndex>)
+
+=item  $fdp->fdp_ip()
+
+Returns remote IP address
+
+(B<fdpCacheAddress>)
+
+=item $fdp->fdp_platform() 
+
+Returns remote platform id 
+
+(B<fdpCachePlatform>)
+
+=item $fdp->fdp_port()
+
+Returns remote port ID
+
+(B<fdpDevicePort>)
+
+=item  $fdp->fdp_proto()
+
+Returns remote address type received.  Usually IP.
+
+(B<fdpCacheAddressType>)
+
+=item $fdp->fdp_ver() 
+
+Returns remote hardware version
+
+(B<fdpCacheVersion>)
+
+=item $fdp->fdp_vlan()
+
+Returns the remote interface native VLAN.
+
+(B<fdpCacheNativeVLAN>)
+
+=back
+
+=cut

Info/Layer3/Foundry.pm

@@ -38,10 +38,11 @@ use strict;
 use Exporter;
 use SNMP::Info;
 use SNMP::Info::Bridge;
+use SNMP::Info::FDP;
 
 use vars qw/$VERSION $DEBUG %GLOBALS %FUNCS $INIT %MIBS %MUNGE/;
 
-@SNMP::Info::Layer3::Foundry::ISA = qw/SNMP::Info SNMP::Info::Bridge Exporter/;
+@SNMP::Info::Layer3::Foundry::ISA = qw/SNMP::Info SNMP::Info::Bridge SNMP::Info::FDP Exporter/;
 @SNMP::Info::Layer3::Foundry::EXPORT_OK = qw//;
 
 $DEBUG=0;
@@ -51,6 +52,7 @@ $INIT = 0;
 
 %MIBS = ( %SNMP::Info::MIBS,
           %SNMP::Info::Bridge::MIBS,
+          %SNMP::Info::FDP::MIBS,
           'FOUNDRY-SN-ROOT-MIB' => 'foundry',
           # IP-FORWARD-MIB
           # ETHERLIKE-MIB
@@ -63,6 +65,7 @@ $INIT = 0;
             # Inherit the super class ones
             %SNMP::Info::GLOBALS,
             %SNMP::Info::Bridge::GLOBALS,
+            %SNMP::Info::FDP::GLOBALS,
             'mac'        => 'ifPhysAddress.1',
             'chassis'    => 'entPhysicalDescr.1',
             'serial'     => 'snChasSerNum',
@@ -80,6 +83,7 @@ $INIT = 0;
 %FUNCS   = (
             %SNMP::Info::FUNCS,
             %SNMP::Info::Bridge::FUNCS,
+            %SNMP::Info::FDP::FUNCS,
             'i_name2'    => 'ifName',
             # From RFC1213-MIB
             'at_index'    => 'ipNetToMediaIfIndex',
@@ -97,6 +101,7 @@ $INIT = 0;
             # Inherit all the built in munging
             %SNMP::Info::MUNGE,
             %SNMP::Info::Bridge::MUNGE,
+            %SNMP::Info::FDP::MUNGE,
             'at_paddr' => \&SNMP::Info::munge_mac,
          );
 
@@ -201,6 +206,28 @@ sub model {
     return $model;
 }
 
+sub os {
+    my $foundry = shift;
+    my $descr = $foundry->description();
+    if ($descr =~ m/IronWare/i) {
+        return 'IronWare';
+    }
+
+    return 'foundry';
+}
+sub os_ver {
+    my $foundry = shift;
+    my $os_version = $foundry->os_version();
+    return $os_version if defined $os_version;
+    # Some older ones don't have this value,so we cull it from the description
+    my $descr = $foundry->description();
+    if ($descr =~ m/Version (\d\S*)/) {
+        return $1;
+    }
+    return undef;
+}
+
+
 # $foundry->interfaces() - Map the Interfaces to their physical names
 sub interfaces {
     my $foundry = shift;