diff options
Diffstat (limited to 'tools/lldpdiscover.pl')
-rwxr-xr-x | tools/lldpdiscover.pl | 317 |
1 files changed, 0 insertions, 317 deletions
diff --git a/tools/lldpdiscover.pl b/tools/lldpdiscover.pl deleted file mode 100755 index f3df093..0000000 --- a/tools/lldpdiscover.pl +++ /dev/null @@ -1,317 +0,0 @@ -#! /usr/bin/perl -# -# Basic tool to discover your neighbourhood systems, using LLDP, as seen -# through SNMP. -# -# Usage: ./lldpdiscover.pl <ip> <community> -# -# This will connect to <ip> and poll it for SNMP-data, then add that to an -# asset database. After that's done, we parse the LLDP neighbor table -# provided over SNMP and add those systems to assets, then try to probe -# THEM with SNMP, using the same community, and so on. -# -# If the entire internet exposed LLDP and SNMP in a public domain, we could -# theoretically map the whole shebang. -# -# Note that leaf nodes do NOT need to reply to SNMP to be added, but -# without SNMP, there'll obviously be some missing data. -# -# The output is a JSON blob of all assets, indexed by chassis id. It also -# includes a neighbor table for each asset which can be used to generate a -# map (See dotnet.sh or draw-neighbors.pl for examples). It can also be -# used to add the assets to NMS. -# -# A sensible approach might be to run this periodically, store the results -# to disk, then have multiple tools parse the results. -use POSIX; -use Time::HiRes; -use strict; -use warnings; -use Data::Dumper; - -use lib '../include'; -use nms; - -# Actual assets detected, indexed by chassis ID -my %assets; - -# Tracking arrays. Continue scanning until they are of the same length. -my @chassis_ids_checked; -my @chassis_ids_to_check; - -# If we are given one switch on the command line, add that and then exit. -my ($cmdline_ip, $cmdline_community) = @ARGV; -if (defined($cmdline_ip) && defined($cmdline_community)) { - my $chassis_id; - eval { - # Special-case for the first switch is to fetch chassis id - # directly. Everything else is fetched from a neighbour - # table. - my $session = nms::snmp_open_session($cmdline_ip, $cmdline_community); - $chassis_id = get_lldp_chassis_id($session); - $assets{$chassis_id}{'community'} = $cmdline_community; - @{$assets{$chassis_id}{'v4mgmt'}} = ($cmdline_ip); - @{$assets{$chassis_id}{'v6mgmt'}} = (); - push @chassis_ids_to_check, $chassis_id; - }; - if ($@) { - mylog("Error during SNMP : $@"); - exit 1; - } - - # Welcome to the main loop! - while (scalar @chassis_ids_to_check > scalar @chassis_ids_checked) { - # As long as you call it something else, it's not really a - # goto-statement, right!? - OUTER: for my $id (@chassis_ids_to_check) { - for my $id2 (@chassis_ids_checked) { - if ($id2 eq $id) { - next OUTER; - } - } - mylog("Adding $id"); - add_switch($id); - mylog("Discovering neighbors for $id"); - discover_lldp_neighbors($id); - push @chassis_ids_checked,$id; - } - } - print JSON::XS::encode_json(\%assets); - # Creates corrupt output, hooray. -# print JSON::XS->new->pretty(1)->encode(\%assets); - exit; -} else { - print "RTFSC\n"; -} -# Filter out stuff we don't scan. Return true if we care about it. -# XXX: Several of these things are temporary to test (e.g.: AP). -sub filter { - my %sys = %{$_[0]}; - my %caps = %{$sys{'lldpRemSysCapEnabled'}}; - my $sysdesc = $sys{'lldpRemSysDesc'}; - my $sysname = $sys{'lldpRemSysName'}; - - if ($caps{'cap_enabled_ap'}) { - return 1; - } - if ($caps{'cap_enabled_telephone'}) { - return 0; - } - if (!defined($sysdesc)) { - return 1; - } - if ($sysdesc =~ /\b(C1530|C3600|C3700)\b/) { - return 0; - } - if (!$caps{'cap_enabled_bridge'} && !$caps{'cap_enabled_router'}) { - return 1; - } - if ($sysname =~ /BCS-OSL/) { - return 1; - } - return 1; -} - -# Discover neighbours of a switch. The data needed is already present int -# %assets , so this shouldn't cause any extra SNMP requests. It will add -# new devices as it finds them. -sub discover_lldp_neighbors { - my $local_id = $_[0]; - my $ip = $assets{$local_id}{mgmt}; - my $local_sysname = $assets{$local_id}{snmp}{sysName}; - my $community = $assets{$local_id}{community}; - my $addrtable; - while (my ($key, $value) = each %{$assets{$local_id}{snmp_parsed}{lldpRemTable}}) { - my $chassis_id = $value->{'lldpRemChassisId'}; - my $sysname = $value->{'lldpRemSysName'}; - if (!defined($sysname)) { - $sysname = $chassis_id; - } - - # Do not try to poll servers. - if (!filter(\%{$value})) { - mylog("Filtered out $sysname ($local_sysname -> $sysname)"); - next; - } - - # Pull in the management address table lazily. - $addrtable = $assets{$local_id}{snmp_parsed}{lldpRemManAddrTable}{$key}; - - # Search for this key in the address table. - my @v4addrs = (); - my @v6addrs = (); - while (my ($addrkey, $addrvalue) = each %$addrtable) { - my $addr = $addrvalue->{'lldpRemManAddr'}; - my $addrtype = $addrvalue->{'lldpRemManAddrSubtype'}; - if ($addrtype == 1) { - push @v4addrs, $addr; - } elsif ($addrtype == 2) { - my $v6addr = $addr; - next if $v6addr =~ /^fe80:/; # Ignore link-local. - push @v6addrs, $v6addr; - } else { - die "Unknown address type $addr"; - } - } - my $addr; - if (scalar @v6addrs > 0) { - $addr = $v6addrs[0]; - } elsif (scalar @v4addrs > 0) { - $addr = $v4addrs[0]; - } else { - mylog( "Could not find a management address for chassis ID $chassis_id (sysname=$sysname, lldpRemIndex=$key)"); - # We still want to add these weirdo-things, but - # they wont do much good except fill the map. - } - - mylog("Found $sysname ($local_sysname -> $sysname )"); - $sysname =~ s/\..*$//; - if (defined($assets{$chassis_id}{'sysName'})) { - mylog("Duplicate $sysname: \"$sysname\" vs \"$assets{$chassis_id}{'sysName'}\""); - if ($assets{$chassis_id}{'sysName'} eq "") { - $assets{$chassis_id}{'sysName'} = $sysname; - } - } else { - $assets{$chassis_id}{'sysName'} = $sysname; - } - - # FIXME: We should handle duplicates better and for more - # than just sysname. These happen every time we are at - # least one tier down (given A->{B,C,D,E}, switch B, C, D - # and E will all know about A, thus trigger this). We also - # want to _add_ information only, since two nodes might - # know about the same switch, but one might have incomplete - # information (as is the case when things start up). - - # We simply guess that the community is the same as ours. - $assets{$chassis_id}{'community'} = $community; - @{$assets{$chassis_id}{'v4mgmt'}} = @v4addrs; - @{$assets{$chassis_id}{'v6mgmt'}} = @v6addrs; - - $assets{$chassis_id}{'neighbors'}{$local_id} = 1; - $assets{$local_id}{'neighbors'}{$chassis_id} = 1; - check_neigh($chassis_id); - } -} - -sub mylog { - my $msg = shift; - my $time = POSIX::ctime(time); - $time =~ s/\n.*$//; - printf STDERR "[%s] %s\n", $time, $msg; -} - -# Get raw SNMP data for an ip/community. -# FIXME: This should be seriously improved. Three get()'s and four -# gettables could definitely be streamlined, but then again, I doubt it -# matters much unless we start running this tool constantly. -sub get_snmp_data { - my ($ip, $community) = @_; - my %ret = (); - eval { - my $session = nms::snmp_open_session($ip, $community); - $ret{'sysName'} = $session->get('sysName.0'); - $ret{'sysDescr'} = $session->get('sysDescr.0'); - $ret{'lldpRemManAddrTable'} = $session->gettable("lldpRemManAddrTable"); - $ret{'lldpRemTable'} = $session->gettable("lldpRemTable"); - $ret{'ifTable'} = $session->gettable('ifTable', columns => [ 'ifType', 'ifDescr' ]); - $ret{'ifXTable'} = $session->gettable('ifXTable', columns => [ 'ifHighSpeed', 'ifName' ]); - $ret{'lldpLocChassisId'} = $session->get('lldpLocChassisId.0'); - }; - if ($@) { - mylog("Error during SNMP to $ip : $@"); - return undef; - } - return \%ret; -} - -# Filter raw SNMP data over to something more legible. -# This is the place to add all post-processed results so all parts of the -# tool can use them. -sub parse_snmp -{ - my $snmp = $_[0]; - my %result = (); - while (my ($key, $value) = each %{$snmp}) { - $result{$key} = $value; - } - $result{lldpLocChassisId} = nms::convert_mac($snmp->{'lldpLocChassisId'}); - while (my ($key, $value) = each %{$snmp->{lldpRemTable}}) { - my $id = $key; - my $chassis_id = nms::convert_mac($value->{'lldpRemChassisId'}); - my $sysname = $value->{'lldpRemSysName'}; - foreach my $key2 (keys %$value) { - $result{lldpRemTable}{$id}{$key2} = $value->{$key2}; - } - $result{lldpRemTable}{$id}{'lldpRemChassisId'} = $chassis_id; - my %caps = (); - nms::convert_lldp_caps($value->{'lldpRemSysCapEnabled'}, \%caps); - $result{lldpRemTable}{$id}{'lldpRemSysCapEnabled'} = \%caps; - } - $result{lldpRemManAddrTable} = (); - while (my ($key, $value) = each %{$snmp->{lldpRemManAddrTable}}) { - my %tmp = (); - foreach my $key2 (keys %$value) { - $tmp{$key2} = $value->{$key2}; - } - my $addr = $value->{'lldpRemManAddr'}; - my $addrtype = $value->{'lldpRemManAddrSubtype'}; - if ($addrtype == 1) { - $tmp{lldpRemManAddr} = nms::convert_ipv4($addr); - } elsif ($addrtype == 2) { - $tmp{lldpRemManAddr} = nms::convert_ipv6($addr); - } - my $id = $value->{lldpRemTimeMark} . "." . $value->{lldpRemLocalPortNum} . "." . $value->{lldpRemIndex}; - my $id2 = $tmp{lldpRemManAddr}; - $result{lldpRemManAddrTable}{$id}{$id2} = \%tmp; - } - return \%result; -} - -# Add a chassis_id to the list to be checked, but only if it isn't there. -# I'm sure there's some better way to do this, but meh, perl. Doesn't even -# have half-decent prototypes. -sub check_neigh { - my $n = $_[0]; - for my $v (@chassis_ids_to_check) { - if ($v eq $n) { - return 0; - } - } - push @chassis_ids_to_check,$n; - return 1; -} - -# We've got a switch. Populate it with SNMP data (if we can). -sub add_switch { - my $chassis_id = shift; - my @addrs; - push @addrs, @{$assets{$chassis_id}{'v4mgmt'}}; - push @addrs, @{$assets{$chassis_id}{'v6mgmt'}}; - my $addr; - my $snmp = undef; - while (my $key = each @addrs ) { - $addr = $addrs[$key]; - mylog("Probing $addr"); - $snmp = get_snmp_data($addr, $assets{$chassis_id}{'community'}); - if (defined($snmp)) { - last; - } - - } - return if (!defined($snmp)); - my $sysname = $snmp->{sysName}; - $sysname =~ s/\..*$//; - $assets{$chassis_id}{'sysName'} = $sysname; - $assets{$chassis_id}{'mgmt'} = $addr; - $assets{$chassis_id}{'snmp'} = $snmp; - $assets{$chassis_id}{'snmp_parsed'} = parse_snmp($snmp); - $assets{$chassis_id}{'chassis_id_x'} = nms::convert_mac($snmp->{'lldpLocChassisId'}); - return; -} - -sub get_lldp_chassis_id { - my ($session) = @_; - my $response = $session->get('lldpLocChassisId.0'); - return nms::convert_mac($response); -} |