From e21f22bb3b8527fe88dff29fcfe5843ac1eb3d4f Mon Sep 17 00:00:00 2001 From: Oliver Gorwits Date: Fri, 2 Mar 2018 23:42:46 +0000 Subject: [PATCH] initial Cumulus Networks support --- lib/SNMP/Info.pm | 1 + lib/SNMP/Info/Layer3/Cumulus.pm | 273 ++++++++++++++++++++++++++++++++ 2 files changed, 274 insertions(+) create mode 100644 lib/SNMP/Info/Layer3/Cumulus.pm diff --git a/lib/SNMP/Info.pm b/lib/SNMP/Info.pm index 8f9943c6..55f04707 100644 --- a/lib/SNMP/Info.pm +++ b/lib/SNMP/Info.pm @@ -1585,6 +1585,7 @@ sub device_type { 41112 => 'SNMP::Info::Layer2::Ubiquiti', 4413 => 'SNMP::Info::Layer2::Ubiquiti', 30803 => 'SNMP::Info::Layer3::VyOS', + 40310 => 'SNMP::Info::Layer3::Cumulus', ); my %l2sysoidmap = ( diff --git a/lib/SNMP/Info/Layer3/Cumulus.pm b/lib/SNMP/Info/Layer3/Cumulus.pm new file mode 100644 index 00000000..34995f37 --- /dev/null +++ b/lib/SNMP/Info/Layer3/Cumulus.pm @@ -0,0 +1,273 @@ +# SNMP::Info::Layer3::Cumulus +# $Id$ +# +# Copyright (c) 2018 Bill Fenner and Oliver Gorwits +# 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::Cumulus; + +use strict; +use Exporter; +use SNMP::Info::Layer3; +use SNMP::Info::LLDP; +use SNMP::Info::IEEE802dot3ad 'agg_ports_lag'; + +@SNMP::Info::Layer3::Cumulus::ISA = qw/ + SNMP::Info::IEEE802dot3ad + SNMP::Info::LLDP + SNMP::Info::Layer3 + Exporter +/; +@SNMP::Info::Layer3::Cumulus::EXPORT_OK = qw/ agg_ports /; + +use vars qw/$VERSION %GLOBALS %MIBS %FUNCS %MUNGE/; + +$VERSION = '3.47'; + +%MIBS = ( + %SNMP::Info::Layer3::MIBS, + %SNMP::Info::LLDP::MIBS, + %SNMP::Info::IEEE802dot3ad::MIBS, + 'UCD-SNMP-MIB' => 'versionTag', + 'NET-SNMP-TC' => 'netSnmpAgentOIDs', + 'HOST-RESOURCES-MIB' => 'hrSystem', +); + +%GLOBALS = ( + %SNMP::Info::Layer3::GLOBALS, + %SNMP::Info::LLDP::GLOBALS, + 'netsnmp_vers' => 'versionTag', + 'hrSystemUptime' => 'hrSystemUptime', + 'chassis' => 'entPhysicalDescr.1', +); + +%FUNCS = ( + %SNMP::Info::Layer3::FUNCS, + %SNMP::Info::LLDP::FUNCS, +); + +%MUNGE = ( + %SNMP::Info::Layer3::MUNGE, + %SNMP::Info::LLDP::MUNGE, +); + +sub vendor { return 'Cumulus Networks' } + +sub os { return 'cumulus' } + +sub os_ver { + my $netsnmp = shift; + my $descr = $netsnmp->description(); + +# STRING: "Cumulus Linux version 3.5.1 running on innotek GmbH VirtualBox" + return $1 if ( $descr =~ /^Cumulus Linux (\S+)\s+/ ); + return; +} + +sub model { + my $netsnmp = shift; + my $chassis = $netsnmp->chassis(); + +# STRING: "Cumulus Networks VX Chassis" + return $1 if ( $chassis =~ /^Cumulus Networks\s+(.+)/ ); + return $netsnmp->SUPER::model(); +} + +# sysUptime gives us the time since the SNMP daemon has restarted, +# so return the system uptime since that's probably what the user +# wants. (Caution: this could cause trouble if using +# sysUptime-based discontinuity timers or other TimeStamp +# objects. +sub uptime { + my $netsnmp = shift; + my $uptime; + + $uptime = $netsnmp->hrSystemUptime(); + return $uptime if defined $uptime; + + return $netsnmp->SUPER::uptime(); +} + +sub i_ignore { + my $l3 = shift; + my $partial = shift; + + my $interfaces = $l3->interfaces($partial) || {}; + + my %i_ignore; + foreach my $if ( keys %$interfaces ) { + + # lo0 etc + if ( $interfaces->{$if} =~ /\blo\d*\b/i ) { + $i_ignore{$if}++; + } + } + return \%i_ignore; +} + +sub agg_ports { return agg_ports_lag(@_) } + +1; +__END__ + +=head1 NAME + +SNMP::Info::Layer3::Cumulus - SNMP Interface to Cumulus Networks Devices + +=head1 AUTHORS + +Oliver Gorwits - based on Layer3::NetSNMP implementation + +=head1 SYNOPSIS + + # Let SNMP::Info determine the correct subclass for you. + my $netsnmp = new SNMP::Info( + AutoSpecify => 1, + Debug => 1, + DestHost => 'myrouter', + Community => 'public', + Version => 2 + ) + or die "Can't connect to DestHost.\n"; + + my $class = $netsnmp->class(); + print "SNMP::Info determined this device to fall under subclass : $class\n"; + +=head1 DESCRIPTION + +Subclass for Generic Net-SNMP devices + +=head2 Inherited Classes + +=over + +=item SNMP::Info::Layer3 + +=back + +=head2 Required MIBs + +=over + +=item F + +=item F + +=item F + +=item Inherited Classes' MIBs + +See L for its own MIB requirements. + +See L for its own MIB requirements. + +=back + +=head1 GLOBALS + +These are methods that return scalar value from SNMP + +=over + +=item $netsnmp->vendor() + +Returns 'Net-SNMP'. + +=item $netsnmp->os() + +Returns the OS extracted from C. + +=item $netsnmp->os_ver() + +Returns the software version extracted from C, along +with the Net-SNMP version. + +=item $netsnmp->uptime() + +Returns the system uptime instead of the agent uptime. +NOTE: discontinuity timers and other Time Stamp based objects +are based on agent uptime, so use orig_uptime(). + +=item $netsnmp->serial() + +Returns ''. + +=back + +=head2 Globals imported from SNMP::Info::Layer3 + +See documentation in L for details. + +=head2 Globals imported from SNMP::Info::LLDP + +See documentation in L 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 $netsnmp->i_ignore() + +Returns reference to hash. Increments value of IID if port is to be ignored. + +Ignores loopback + +=back + +=head2 Table Methods imported from SNMP::Info::Layer3 + +See documentation in L for details. + +=head2 Table Methods imported from SNMP::Info::LLDP + +See documentation in L for details. + +=head1 NOTES + +In order to cause SNMP::Info to classify your device into this class, it +may be necessary to put a configuration line into your F +similar to + + sysobjectid .1.3.6.1.4.1.8072.3.2.N + +where N is the object ID for your OS from the C MIB (or +255 if not listed). Some Net-SNMP installations default to an +incorrect return value for C. + +In order to recognize a Net-SNMP device as Layer3, it may be necessary +to put a configuration line similar to + + sysservices 76 + +in your F. + +=cut