+jeneric's massive Nortel functionality patch. L2::Bay depricated

Info/Layer3/Contivity.pm

@@ -0,0 +1,348 @@
+# SNMP::Info::Layer3::Contivity
+# Eric Miller <eric@jeneric.org>
+#
+# Copyright (c) 2004 Max Baker changes from version 0.8 and beyond.
+#
+# 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::Layer3::Contivity;
+$VERSION = 0.9;
+
+use strict;
+
+use Exporter;
+use SNMP::Info;
+use SNMP::Info::Entity;
+
+use vars qw/$VERSION $DEBUG %GLOBALS %FUNCS $INIT %MIBS %MUNGE/;
+
+@SNMP::Info::Layer3::Contivity::ISA = qw/SNMP::Info SNMP::Info::Entity Exporter/;
+@SNMP::Info::Layer3::Contivity::EXPORT_OK = qw//;
+
+$DEBUG=0;
+
+# See SNMP::Info for the details of these data structures and 
+# the interworkings.
+$INIT = 0;
+
+%MIBS = (
+         %SNMP::Info::MIBS,
+         %SNMP::Info::Entity::MIBS,
+        );
+
+%GLOBALS = (
+           %SNMP::Info::GLOBALS,
+           %SNMP::Info::Entity::GLOBALS,
+           );
+
+%FUNCS = (
+          %SNMP::Info::FUNCS,
+          %SNMP::Info::Entity::FUNCS,
+          'i_name2'     => 'ifName',
+          # From RFC1213-MIB
+          'at_index'    => 'ipNetToMediaIfIndex',
+          'at_paddr'    => 'ipNetToMediaPhysAddress',
+          'at_netaddr'  => 'ipNetToMediaNetAddress',
+         );
+         
+%MUNGE = (
+          %SNMP::Info::MUNGE,
+          %SNMP::Info::Entity::MUNGE,
+          'at_paddr' => \&SNMP::Info::munge_mac,
+         );
+
+sub layers {
+    return '00000100';
+}
+
+sub vendor {
+    return 'nortel';
+}
+
+sub model {
+    my $contivity = shift;
+    my $e_model = $contivity->e_model() || {};
+
+    my $model = $e_model->{1} || undef;
+    
+    return $1 if (defined $model and $model =~ /(CES\d+)/i);
+    return undef;
+}
+
+sub os {
+    return 'contivity';
+}
+
+sub os_ver {
+    my $contivity = shift;
+    my $descr = $contivity->description();
+    return undef unless defined $descr;
+
+    if ($descr =~ m/V(\d+_\d+\.\d+)/i){
+        return $1;
+    }
+    return undef;
+}
+
+sub mac {
+    my $contivity = shift;
+    my $i_mac = $contivity->i_mac();
+
+# Return Interface MAC   
+    foreach my $entry (keys %$i_mac){
+        my $sn = $i_mac->{$entry};
+        next unless $sn;
+        return $sn;
+    }
+    return undef;
+}
+
+sub serial {
+    my $contivity = shift;
+    my $e_serial = $contivity->e_serial() || {};
+
+    my $serial = $e_serial->{1} || undef;
+    
+    return $1 if (defined $serial and $serial =~ /(\d+)/);
+    return undef;
+}
+
+
+sub interfaces {
+    my $contivity = shift;
+    my $description = $contivity->i_description();
+    
+    my %interfaces = ();
+    foreach my $iid (keys %$description){
+        my $desc = $description->{$iid};
+        # Skip everything except Ethernet interfaces
+        next unless (defined $desc and $desc =~ /fe/i);
+
+        $interfaces{$iid} = $desc;
+    }
+    return \%interfaces;
+}
+
+sub i_name {
+    my $contivity = shift;
+    my $i_name2 = $contivity->i_name2();
+    
+    my %i_name;
+    foreach my $iid (keys %$i_name2){
+	my $name = $i_name2->{$iid};
+       #Skip everything except Ethernet interfaces
+	next unless (defined $name and $name =~ /fe/i);
+	
+	$name = $1 if $name =~ /(fei\.\d+\.\d+)/;
+	
+	$i_name{$iid} = $name;
+     }
+     return \%i_name;
+}
+
+sub root_ip {
+    my $contivity = shift;
+    my $ip_table = $contivity->ip_table();
+
+# Return First IP Address    
+    foreach my $entry (keys %$ip_table){
+        my $router_ip = $ip_table->{$entry};
+        print " SNMP::Layer3::Contivity::root_ip() using $router_ip\n" if $DEBUG;
+        next unless $router_ip;
+        return $router_ip if ($router_ip ne '0.0.0.0');
+    }
+    return undef;
+}
+
+1;
+__END__
+
+=head1 NAME
+
+SNMP::Info::Layer3::Contivity - Perl5 Interface to Nortel Networks' Contivity
+Extranet Switches (CES).
+
+=head1 AUTHOR
+
+Eric Miller (C<eric@jeneric.org>)
+
+=head1 SYNOPSIS
+
+ # Let SNMP::Info determine the correct subclass for you. 
+ my $contivity = new SNMP::Info(
+                          AutoSpecify => 1,
+                          Debug       => 1,
+                          # These arguments are passed directly on to SNMP::Session
+                          DestHost    => 'myswitch',
+                          Community   => 'public',
+                          Version     => 2
+                        ) 
+    or die "Can't connect to DestHost.\n";
+
+ my $class      = $contivity->class();
+ print "SNMP::Info determined this device to fall under subclass : $class\n";
+
+=head1 DESCRIPTION
+
+Abstraction subclass for Nortel Networks' Contivity Extranet Switch (CES).  
+
+For speed or debugging purposes you can call the subclass directly, but not after determining
+a more specific class using the method above. 
+
+ my $contivity = new SNMP::Info::Layer3::Contivity(...);
+
+=head2 Inherited Classes
+
+=over
+
+=item SNMP::Info
+
+=item SNMP::Info::Entity
+
+=back
+
+=head2 Required MIBs
+
+=over
+
+=item Inherited Classes' MIBs
+
+See SNMP::Info for its own MIB requirements.
+
+See SNMP::Info::Entity for its own MIB requirements.
+
+=back
+
+=head1 GLOBALS
+
+These are methods that return scalar value from SNMP
+
+=over
+
+=item $contivity->vendor()
+
+Returns 'Nortel'
+
+=item $contivity->model()
+
+Returns the chassis name.
+
+(B<entPhysicalModelName.1>)
+
+=item $contivity->os()
+
+Returns 'CES'
+
+=item $contivity->os_ver()
+
+Returns the software version extracted from (B<sysDescr>).
+
+=item $contivity->serial()
+
+Returns the chassis serial number.
+
+(B<entPhysicalSerialNum.1>)
+
+=item $contivity->mac()
+
+Returns the MAC address of the first Ethernet Interface.
+
+=item $contivity->root_ip()
+
+Returns the primary IP used to communicate with the router.  Returns the first
+IP interface.
+
+=back
+
+=head2 Overrides
+
+=over
+
+=item $contivity->layers()
+
+Returns 00000100.  Contivity does not support bridge MIB, so override reported
+layers.
+
+=back
+
+=head2 Globals imported from SNMP::Info
+
+See documentation in SNMP::Info for details.
+
+=head2 Globals imported from SNMP::Info::Entity
+
+See documentation in SNMP::Info::Entity for details.
+
+=head1 TABLE ENTRIES
+
+These are methods that return tables of information in the form of a reference
+to a hash.
+
+=head2 Overrides
+
+=over
+
+=item $contivity->interfaces()
+
+Returns reference to the map between IID and physical Port.  Skips loopback and
+tunnel interfaces.
+
+=back
+
+=head2 RFC1213 Arp Cache Table (B<ipNetToMediaTable>)
+
+=over
+
+=item $contivity->at_index()
+
+Returns reference to hash.  Maps ARP table entries to Interface IIDs 
+
+(B<ipNetToMediaIfIndex>)
+
+=item $contivity->at_paddr()
+
+Returns reference to hash.  Maps ARP table entries to MAC addresses. 
+
+(B<ipNetToMediaPhysAddress>)
+
+=item $contivity->at_netaddr()
+
+Returns reference to hash.  Maps ARP table entries to IPs 
+
+(B<ipNetToMediaNetAddress>)
+
+=back
+
+=head2 Table Methods imported from SNMP::Info
+
+See documentation in SNMP::Info for details.
+
+=head2 Table Methods imported from SNMP::Info::Entity
+
+See documentation in SNMP::Info::Entity for details.
+
+=cut