419 lines
12 KiB
Perl
419 lines
12 KiB
Perl
# SNMP::Info::Layer2::Ubiquiti - SNMP Interface to Ubiquiti Devices
|
|
#
|
|
# Copyright (c) 2019 by The Netdisco Developer Team.
|
|
#
|
|
# 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::Layer2::Ubiquiti;
|
|
|
|
use strict;
|
|
use warnings;
|
|
use Exporter;
|
|
use SNMP::Info::IEEE802dot11;
|
|
use SNMP::Info::Layer2;
|
|
use SNMP::Info::Layer3; # only used in sub mac()
|
|
|
|
|
|
|
|
@SNMP::Info::Layer2::Ubiquiti::ISA
|
|
= qw/SNMP::Info::IEEE802dot11 SNMP::Info::Layer2 Exporter/;
|
|
@SNMP::Info::Layer2::Ubiquiti::EXPORT_OK = qw//;
|
|
|
|
our ($VERSION, %FUNCS, %GLOBALS, %MIBS, %MUNGE);
|
|
|
|
$VERSION = '3.73';
|
|
|
|
%MIBS = (
|
|
%SNMP::Info::Layer2::MIBS,
|
|
%SNMP::Info::IEEE802dot11::MIBS,
|
|
);
|
|
|
|
%GLOBALS = (
|
|
%SNMP::Info::Layer2::GLOBALS,
|
|
%SNMP::Info::IEEE802dot11::GLOBALS,
|
|
);
|
|
|
|
%FUNCS = (
|
|
%SNMP::Info::Layer2::FUNCS,
|
|
%SNMP::Info::IEEE802dot11::FUNCS,
|
|
);
|
|
|
|
%MUNGE = ( %SNMP::Info::Layer2::MUNGE, %SNMP::Info::IEEE802dot11::MUNGE, );
|
|
|
|
sub os {
|
|
my $ubnt = shift;
|
|
|
|
my $names = $ubnt->dot11_prod_name();
|
|
|
|
foreach my $iid ( keys %$names ) {
|
|
my $prod = $names->{$iid};
|
|
next unless defined $prod;
|
|
# Product names that match AirOS products
|
|
if((lc $prod) =~ /station/ or (lc $prod) =~ /beam/ or (lc $prod) =~ /grid/){
|
|
return 'AirOS';
|
|
# Product names that match UAP
|
|
}elsif((lc $prod) =~ /uap/){
|
|
return 'UniFi';
|
|
}else{
|
|
# Continue below to find OS name
|
|
}
|
|
}
|
|
|
|
## EdgeMAX OS (EdgeSwitch and EdgeRouter) name is first field split by space
|
|
my $ver = $ubnt->description() || '';
|
|
|
|
my @myver = split(/ /, $ver);
|
|
|
|
return $myver[0];
|
|
}
|
|
|
|
sub os_ver {
|
|
my $ubnt = shift;
|
|
|
|
my $versions = $ubnt->dot11_prod_ver();
|
|
|
|
foreach my $iid ( keys %$versions ) {
|
|
my $ver = $versions->{$iid};
|
|
next unless defined $ver;
|
|
my $os = $ubnt->os;
|
|
if($os == 'AirOS'){
|
|
## pretty up the version reporting for AirOS to include hardware (XW, XM, etc) and three major groups of firmware
|
|
my @firmware = split(/v/, $ver);
|
|
my @firmwareSplit = split(/\./, $firmware[1]);
|
|
my @prefix = split(/\./, $ver);
|
|
$ver = $prefix[0] . '-v' . join('.', @firmwareSplit[0,1,2]);
|
|
}
|
|
return $ver;
|
|
## Not sure what this function does, it seems to be extraneous being in the same code block after a return statement?
|
|
#if ( $ver =~ /([\d\.]+)/ ) {
|
|
# return $1;
|
|
#}
|
|
}
|
|
|
|
my $ver = $ubnt->description() || '';
|
|
if((lc $ver) =~ /^edgeswitch/){
|
|
## EdgeSwitch OS version is second field split by comma and bootcode version is last
|
|
my @myver = split(/, /, $ver);
|
|
my @firmware = split(/\./, $myver[1]);
|
|
my @bootcode = split(/\./, $myver[-1]);
|
|
|
|
## Return only three major version groupings and include bootcode version
|
|
return join('.', @firmware[0,1,2]) . '.-b' . join('.', @bootcode[0,1,2]);
|
|
|
|
}
|
|
|
|
## EdgeRouter OS version is second field split by space
|
|
my @myver = split(/ /, $ver);
|
|
my @firmware = split(/\./, $myver[1]);
|
|
|
|
if($firmware[2] =~ /hotfix$/){
|
|
# edge case where EdgeOS has hotfix versions in format "EdgeOS v1.9.7+hotfix.4.5024004.171005.0403"
|
|
$firmware[2] = $firmware[2] . '.' . $firmware[3]
|
|
}
|
|
## Return only three major version groupings
|
|
return join('.', @firmware[0,1,2]);
|
|
}
|
|
|
|
sub vendor {
|
|
return 'ubiquiti';
|
|
}
|
|
|
|
sub model {
|
|
my $ubnt = shift;
|
|
|
|
my $names = $ubnt->dot11_prod_name();
|
|
|
|
foreach my $iid ( keys %$names ) {
|
|
my $prod = $names->{$iid};
|
|
next unless defined $prod;
|
|
return $prod;
|
|
}
|
|
|
|
my $desc = $ubnt->description() || '';
|
|
|
|
## Pull Model from beginning of description, separated by comma (EdgeSwitch)
|
|
if((lc $desc) =~ /^edgeswitch/){
|
|
my @mydesc = split(/, /, $desc);
|
|
return $mydesc[0];
|
|
}
|
|
|
|
if(!((lc $desc) =~ /edgeos/)){
|
|
# Not sure what type of device this is to get Model
|
|
# Wireless devices report dot11_prod_name
|
|
# EdgeSwitch includes model directly and edgeos logic is in else statement
|
|
return ;
|
|
}else{
|
|
## do some logic to determine ER model based on tech specs from ubnt:
|
|
## https://help.ubnt.com/hc/en-us/articles/219652227--EdgeRouter-Which-EdgeRouter-Should-I-Use-#tech%20specs
|
|
## Would be nice if UBNT simply adds the model string to their SNMP daemon directly
|
|
my $ethCount = 0;
|
|
my $switchCount = 0;
|
|
#my $sfpCount = 0;
|
|
#my $poeCount = 0;
|
|
my $memTotalReal = $ubnt->memTotalReal;
|
|
my $cpuLoad = $ubnt->hrProcessorLoad;
|
|
my $cpuCount = 0;
|
|
## My perl is lacking. Not sure if there's a more efficient way to find the cpu count
|
|
foreach my $iid ( keys %$cpuLoad ) {
|
|
$cpuCount++;
|
|
}
|
|
|
|
my $ifDescs = $ubnt->ifDescr;
|
|
foreach my $iid ( keys %$ifDescs ) {
|
|
my $ifDesc = $ifDescs->{$iid};
|
|
next unless defined $ifDesc;
|
|
|
|
if((lc $ifDesc) =~ /^eth\d+$/){ # exclude vlan interfaces. Ex: eth1.5
|
|
$ethCount++;
|
|
}elsif((lc $ifDesc) =~ /^switch/){
|
|
$switchCount++;
|
|
}
|
|
}
|
|
|
|
## If people have other models to further fine-tune this logic that would be great.
|
|
if($ethCount eq 9){
|
|
## Should be ER Infinity
|
|
return "EdgeRouter Infinity"
|
|
}if($ethCount eq 8){
|
|
## Could be ER-8 Pro, ER-8, or EP-R8
|
|
return "EdgeRouter 8-Port"
|
|
}if($ethCount eq 12){
|
|
## ER-12
|
|
return "EdgeRouter 12-Port"
|
|
}elsif($ethCount eq 5 and $cpuCount eq 4){
|
|
## Could be ER-X or ER-X-SFP
|
|
return "EdgeRouter X 5-Port"
|
|
}elsif($ethCount eq 5){
|
|
return "EdgeRouter PoE 5-Port"
|
|
}elsif($ethCount eq 3 and $cpuCount eq 2){
|
|
return "EdgeRouter LITE 3-Port"
|
|
}else{
|
|
## failback string
|
|
return "EdgeRouter eth-$ethCount switch-$switchCount mem-$memTotalReal cpuNum-$cpuCount";
|
|
}
|
|
|
|
}
|
|
}
|
|
|
|
## simply take the MAC and clean it up
|
|
sub serial {
|
|
my $ubnt = shift;
|
|
|
|
my $serial = $ubnt->mac();
|
|
if($serial){
|
|
$serial =~ s/://g;
|
|
return uc $serial;
|
|
}
|
|
return ;
|
|
}
|
|
|
|
## UBNT doesn't put the primary-mac interface at index 1
|
|
sub mac {
|
|
my $ubnt = shift;
|
|
my $ifDescs = $ubnt->ifDescr;
|
|
my $erModel = $ubnt->model;
|
|
|
|
foreach my $iid ( keys %$ifDescs ) {
|
|
my $ifDesc = $ifDescs->{$iid};
|
|
next unless defined $ifDesc;
|
|
## CPU Interface will have the primary MAC for EdgeSwitch
|
|
## eth0 will have primary MAC for linux-based UBNT devices, except ER-12 which is eth11
|
|
if($ifDesc =~ /CPU/ or ($ifDesc eq 'eth0' and !($erModel =~ /EdgeRouter 12/)) or ($ifDesc eq 'eth11' and ($erModel =~ /EdgeRouter 12/))){
|
|
my $mac = $ubnt->ifPhysAddress->{$iid};
|
|
|
|
# syntax stolen from sub munge_mac in SNMP::Info
|
|
$mac = lc join( ':', map { sprintf "%02x", $_ } unpack( 'C*', $mac ) );
|
|
return $mac if $mac =~ /^([0-9A-F][0-9A-F]:){5}[0-9A-F][0-9A-F]$/i;
|
|
}
|
|
}
|
|
|
|
# MAC malformed or missing
|
|
return;
|
|
}
|
|
|
|
sub interfaces {
|
|
my $ubnt = shift;
|
|
my $partial = shift;
|
|
|
|
my $interfaces = $ubnt->i_index($partial) || {};
|
|
my $i_descr = $ubnt->i_description($partial) || {};
|
|
my $return = {};
|
|
|
|
foreach my $iid ( keys %$i_descr ) {
|
|
# Slot: 0 Port: 4 Gigabit - Level
|
|
if ($i_descr->{$iid} =~ m/([0-9]+)[^0-9]+([0-9]+)/) {
|
|
$return->{$iid} = $1 .'/'. $2;
|
|
next;
|
|
}
|
|
# Link Aggregate 4
|
|
if ($i_descr->{$iid} =~ m/Link Aggregate (\d+)/) {
|
|
$return->{$iid} = '3/'. $1;
|
|
next;
|
|
}
|
|
# else
|
|
$return->{$iid} = $i_descr->{$iid};
|
|
}
|
|
|
|
return $return;
|
|
}
|
|
|
|
sub i_ignore {
|
|
my $l2 = shift;
|
|
my $partial = shift;
|
|
|
|
my $interfaces = $l2->interfaces($partial) || {};
|
|
my $i_descr = $l2->i_description($partial) || {};
|
|
|
|
my %i_ignore;
|
|
foreach my $if ( keys %$interfaces ) {
|
|
|
|
# CPU Interface
|
|
if ( $i_descr->{$if} =~ /CPU Interface/i ) {
|
|
$i_ignore{$if}++;
|
|
}
|
|
}
|
|
return \%i_ignore;
|
|
}
|
|
|
|
1;
|
|
__END__
|
|
|
|
=head1 NAME
|
|
|
|
SNMP::Info::Layer2::Ubiquiti - SNMP Interface to Ubiquiti Access Points
|
|
|
|
=head1 AUTHOR
|
|
|
|
Max Kosmach
|
|
|
|
=head1 SYNOPSIS
|
|
|
|
# Let SNMP::Info determine the correct subclass for you.
|
|
my $ubnt = new SNMP::Info(
|
|
AutoSpecify => 1,
|
|
Debug => 1,
|
|
DestHost => 'myswitch',
|
|
Community => 'public',
|
|
Version => 2
|
|
)
|
|
or die "Can't connect to DestHost.\n";
|
|
|
|
my $class = $ubnt->class();
|
|
print "SNMP::Info determined this device to fall under subclass : $class\n";
|
|
|
|
=head1 DESCRIPTION
|
|
|
|
Provides abstraction to the configuration information obtainable from
|
|
Ubiquiti Access Point through SNMP.
|
|
|
|
=head2 Inherited Classes
|
|
|
|
=over
|
|
|
|
=item SNMP::Info::Layer2
|
|
|
|
=item SNMP::Info::IEEE802dot11
|
|
|
|
=back
|
|
|
|
=head2 Required MIBs
|
|
|
|
None.
|
|
|
|
=head2 Inherited MIBs
|
|
|
|
See L<SNMP::Info::Layer2/"Required MIBs"> for its MIB requirements.
|
|
|
|
See L<SNMP::Info::IEEE802dot11/"Required MIBs"> for its MIB requirements.
|
|
|
|
=head1 GLOBALS
|
|
|
|
These are methods that return scalar value from SNMP
|
|
|
|
=over
|
|
|
|
=item $ubnt->vendor()
|
|
|
|
Returns 'ubiquiti'
|
|
|
|
=item $ubnt->model()
|
|
|
|
Returns the model extracted from C<dot11manufacturerProductName>, with fallback to some complex logic for EdgeMax devices
|
|
|
|
=item $ubnt->serial()
|
|
|
|
Serial Number.
|
|
|
|
=item $ubnt->mac()
|
|
|
|
Bridge MAC address.
|
|
|
|
=item $ubnt->os()
|
|
|
|
Returns C<AirOS>, C<UniFi> or C<EdgeOS> depending on model.
|
|
|
|
=item $ubnt->os_ver()
|
|
|
|
Returns the software version extracted from C<dot11manufacturerProductVersion>, with fallback to description splitting for EdgeMax devices
|
|
|
|
=back
|
|
|
|
=head2 Global Methods imported from SNMP::Info::Layer2
|
|
|
|
See L<SNMP::Info::Layer2/"GLOBALS"> for details.
|
|
|
|
=head2 Global Methods imported from SNMP::Info::IEEE802dot11
|
|
|
|
See L<SNMP::Info::IEEE802dot11/"GLOBALS"> for details.
|
|
|
|
=head1 TABLE METHODS
|
|
|
|
These are methods that return tables of information in the form of a reference
|
|
to a hash.
|
|
|
|
=head2 Overrides
|
|
|
|
=over
|
|
|
|
=item $ubnt->interfaces()
|
|
|
|
Uses the i_name() field.
|
|
|
|
=item $ubnt->i_ignore()
|
|
|
|
Ignores interfaces with "CPU Interface" in them.
|
|
|
|
=back
|
|
|
|
=head2 Table Methods imported from SNMP::Info::Layer2
|
|
|
|
See L<SNMP::Info::Layer2/"TABLE METHODS"> for details.
|
|
|
|
=head2 Table Methods imported from SNMP::Info::IEEE802dot11
|
|
|
|
See L<SNMP::Info::IEEE802dot11/"TABLE METHODS"> for details.
|
|
|
|
=cut
|