-
Notifications
You must be signed in to change notification settings - Fork 62
/
Device.pm
6654 lines (5625 loc) · 195 KB
/
Device.pm
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
package Netdot::Model::Device;
use base 'Netdot::Model';
use warnings;
use strict;
use SNMP::Info;
use Netdot::Util::DNS;
use Netdot::Topology;
use Parallel::ForkManager;
use Data::Dumper;
=head1 NAME
Netdot::Model::Device - Network Device Class
=head1 SYNOPSIS
my $device = Device->retrieve($id);
$device->snmp_update();
=cut
# Timeout seconds for SNMP queries
# (different from SNMP connections)
my $TIMEOUT = Netdot->config->get('SNMP_QUERY_TIMEOUT');
# Define some signal handlers
$SIG{ALRM} = sub{ die "timeout" };
# Some regular expressions
my $IPV4 = Netdot->get_ipv4_regex();
# Other fixed variables
my $MAXPROCS = Netdot->config->get('SNMP_MAX_PROCS');
# Objects we need here
my $logger = Netdot->log->get_logger('Netdot::Model::Device');
my %IGNOREDVLANS;
map { $IGNOREDVLANS{$_}++ } @{ Netdot->config->get('IGNOREVLANS') };
my @MIBDIRS;
foreach my $md ( @{ Netdot->config->get('SNMP_MIB_DIRS') } ){
push @MIBDIRS, Netdot->config->get('SNMP_MIBS_PATH')."/".$md;
}
# Netdot Interface field name to SNMP::Info method conversion table
my %IFFIELDS = (
type => 'i_type',
description => 'i_alias', speed => 'i_speed',
admin_status => 'i_up_admin', oper_status => 'i_up',
physaddr => 'i_mac', oper_duplex => 'i_duplex',
admin_duplex => 'i_duplex_admin', stp_id => 'i_stp_id',
dp_remote_id => 'c_id', dp_remote_ip => 'c_ip',
dp_remote_port => 'c_port', dp_remote_type => 'c_platform',
);
# DeviceModule field name to SNMP::Info method conversion table
my %MFIELDS = (
name => 'e_name', type => 'e_type',
contained_in => 'e_parent', class => 'e_class',
pos => 'e_pos', hw_rev => 'e_hwver',
fw_rev => 'e_fwver', sw_rev => 'e_swver',
model => 'e_model', serial_number => 'e_serial',
fru => 'e_fru', description => 'e_descr',
);
# SNMP::Info methods that return hash refs
my @SMETHODS = qw(
hasCDP e_descr i_type i_alias i_speed i_up
i_up_admin i_duplex i_duplex_admin
ip_index ip_netmask i_mac ip_table
i_vlan_membership qb_v_name v_name v_state
hasLLDP
);
=head1 CLASS METHODS
=cut
############################################################################
=head2 search - Search Devices
Overrides base method to extend functionality:
Arguments:
Hash with the following keys:
name - Can be either a string, RR object RR id or IP address,
String can be FQDN or hostname.
producttype - Search for all Devices of a certain product type
The rest of the fields in the Device table.
Returns:
Array of Device objects or iterator (depending on context)
Exampless:
my @devs = Device->search(name=>'localhost.localdomain');
=cut
sub search {
my ($class, @args) = @_;
$class->isa_class_method('search');
# Class::DBI::search() might include an extra 'options' hash ref
# at the end. In that case, we want to extract the
# field/value hash first.
my $opts = @args % 2 ? pop @args : {};
my %argv = @args;
my $dev;
if ( defined $argv{name} ){
my $foundname = 0;
if ( ref($argv{name}) =~ /RR$/o ){
# We were passed a RR object.
# Proceed as regular search
}elsif ( Ipblock->matches_ip($argv{name}) ){
# Looks like an IP address
if ( my $ip = Ipblock->search(address=>$argv{name})->first ){
if ( $ip->interface && ($dev = $ip->interface->device) ){
$argv{name} = $dev->name;
$foundname = 1;
}else{
$logger->debug(sub{"Device::search: Address $argv{name} exists but ".
"no Device associated"});
}
}else{
$logger->debug(sub{"Device::search: $argv{name} not found in DB"});
}
}
if ( !$foundname ){
# Notice that we could be looking for a RR with an IP address as name
# So go on.
# name is either a string or a RR id
if ( $argv{name} =~ /\D+/ ){
# argument has non-digits, so it's not an id. Look up RR name
if ( my @rrs = RR->search(name=>$argv{name}) ){
if ( scalar @rrs == 1 ){
$argv{name} = $rrs[0];
}else{
# This means we have the same RR name on different zones
# Try to resolve the name and look up IP address
if ( my @ips = Netdot->dns->resolve_name($argv{name}) ){
foreach my $ip ( @ips ){
$logger->debug(sub{"Device::search: $argv{name} resolves to $ip"});
if ( my $ip = Ipblock->search(address=>$ip)->first ){
if ( $ip->interface && ($dev = $ip->interface->device) ){
$argv{name} = $dev->name;
}elsif ( my @a_records = $ip->a_records ){
# The IP is not assigned to any device interfaces
# but there might be a device with a name and A record
# associated with this IP
$argv{name} = $a_records[0]->rr;
}else{
$argv{name} = 0;
}
}
}
}
}
}else{
# No use searching for a non-digit string in the name field
$argv{name} = 0;
}
}
}
}elsif ( exists $argv{producttype} ){
return $class->search_by_type($argv{producttype});
}
# Proceed as a regular search
return $class->SUPER::search(%argv, $opts);
}
############################################################################
=head2 search_address_live
Query relevant devices for ARP and FWT entries in order to locate
a particular address in the netwrok.
Arguments:
mac - MAC address (required unless ip is given)
ip - IP address (required unless mac is given)
vlan - VLAN id (optional but useful)
Returns:
Hashref with following keys:
edge - Edge port interface id
arp - Hashref with key=interface, value=hashref with key=ip, value=mac
fwt - Hashref with key=interface, value=number of macs
Examples:
my $info = Device->search_address_live(mac=>'DEADDEADBEEF', vlan=60);
=cut
sub search_address_live {
my ($class, %argv) = @_;
$class->isa_class_method('search_address_live');
$class->throw_fatal("Device::search_address_live: Cannot proceed without a MAC or IP")
unless ( $argv{mac} || $argv{ip} );
my (@fwt_devs, @arp_devs);
my ($vlan, $subnet);
my %results;
if ( $argv{vlan} ){
$vlan = Vlan->search(vid=>$argv{vlan})->first;
$class->throw_user("Cannot find VLAN id $argv{vlan}\n")
unless $vlan;
}
if ( $argv{ip} ){
my $ipblock = Ipblock->search(address=>$argv{ip})->first;
if ( $ipblock ){
if ( $ipblock->is_address ){
$subnet = $ipblock->parent;
}else{
$subnet = $ipblock;
}
if ( !$vlan ){
$vlan = $subnet->vlan if $subnet->vlan;
}
@arp_devs = @{$subnet->get_devices()};
}else{
$subnet = Ipblock->get_covering_block(address=>$argv{ip});
if ( $subnet ){
if ( !$vlan ){
$vlan = $subnet->vlan if ( $subnet && $subnet->vlan );
}
@arp_devs = @{$subnet->get_devices()};
}
}
}
if ( $vlan ){
my @ivlans = $vlan->interfaces;
my %fwt_devs;
foreach my $iface ( map { $_->interface } @ivlans ){
$fwt_devs{$iface->device->id} = $iface->device;
}
@fwt_devs = values %fwt_devs;
if ( !@arp_devs && !$subnet ){
foreach my $subnet ( $vlan->subnets ){
@arp_devs = @{$subnet->get_devices()};
}
}
}else{
if ( $subnet && !@fwt_devs ){
@fwt_devs = @{$subnet->get_devices()};
}else{
$class->throw_user("Device::search_address_live: ".
"Cannot proceed without VLAN or IP information\n");
}
}
my (@fwts);
my %routerports;
foreach my $dev ( @arp_devs ){
my $cache;
$dev->_netdot_rebless();
eval {
$cache = $class->_exec_timeout($dev->fqdn, sub{ return $dev->get_arp() });
};
$logger->debug($@) if $@;
if ( $cache ){
foreach my $intid ( keys %$cache ){
foreach my $ip ( keys %{$cache->{$intid}} ){
next if ( $argv{ip} && ($ip ne $argv{ip}) );
my $mac = $cache->{$intid}->{$ip};
next if ( $argv{mac} && ($mac ne $argv{mac}) );
# We now have a mac address if we didn't have it yet
unless ( $argv{mac} ){
$argv{mac} = $mac;
}
# Keep record of all the interfaces where this ip was seen
$routerports{$intid}{$ip} = $mac;
$results{mac} = $mac;
$results{ip} = $ip;
}
}
}
# Do not query all the routers unless needed.
if ( %routerports ){
$results{routerports} = \%routerports;
last;
}
}
# If we do not have a MAC at this point, there's no point in getting FWTs
if ( $argv{mac} ){
$results{mac} = $argv{mac};
foreach my $dev ( @fwt_devs ){
my $fwt;
my %args;
$args{vlan} = $vlan->vid if ( $vlan );
eval {
$fwt = $class->_exec_timeout($dev->fqdn, sub{ return $dev->get_fwt(%args) } );
};
$logger->debug($@) if $@;
push @fwts, $fwt if $fwt;
}
my %switchports;
foreach my $fwt ( @fwts ){
foreach my $intid ( keys %{$fwt} ){
foreach my $mac ( keys %{$fwt->{$intid}} ){
next if ( $mac ne $argv{mac} );
# Keep record of all the interfaces where it was seen
# How many MACs were on that interface is essential to
# determine the edge port
$switchports{$intid} = scalar(keys %{$fwt->{$intid}});
}
}
}
$results{switchports} = \%switchports if %switchports;
# Now look for the port with the least addresses
my @ordered = sort { $switchports{$a} <=> $switchports{$b} } keys %switchports;
$results{edge} = $ordered[0] if $ordered[0];
}
if ( %results ){
if ( $results{mac} ){
if ( my $vendor = PhysAddr->vendor($results{mac}) ){
$results{vendor} = $vendor;
}
}
if ( $results{ip} ){
if ( my $name = Netdot->dns->resolve_ip($results{ip}) ){
$results{dns} = $name;
}
}
return \%results;
}
}
############################################################################
=head2 search_like - Search for device objects. Allow substrings
We override the base class to:
- allow 'name' to be searched as part of a hostname
- search 'name' in aliases field if a RR is not found
- add 'zone' to the list of arguments
Arguments:
Hash with key/value pairs
Returns:
Array of Device objects or iterator
Examples:
my @switches = Device->search_like(name=>'-sw');
=cut
sub search_like {
my ($class, %argv) = @_;
$class->isa_class_method('search_like');
if ( exists $argv{name} ){
my %args = (name=>$argv{name});
$args{zone} = $argv{zone} if $argv{zone};
if ( my @rrs = RR->search_like(%args) ){
return map { $class->search(name=>$_) } @rrs;
}elsif ( $class->SUPER::search_like(aliases=>$argv{name}) ){
return $class->SUPER::search_like(aliases=>$argv{name});
}
$logger->debug(sub{"Device::search_like: $argv{name} not found"});
return;
}elsif ( exists $argv{producttype} ){
return $class->search_by_type($argv{producttype});
}elsif ( exists $argv{product} ){
my $dbh = $class->db_Main;
my $p_bind = defined($argv{product})? "= $argv{product}" : 'IS NULL';
my $crit;
if ( exists $argv{site} ){
my $s_bind = defined($argv{site})? "= ".$dbh->quote($argv{site}) : 'IS NULL';
$crit = " AND d.site $s_bind";
}elsif ( exists $argv{os} ){
my $o_bind = defined($argv{os})? "= ".$dbh->quote($argv{os}) : 'IS NULL';
$crit = " AND d.os $o_bind";
}
my @objs;
my $rows = Netdot::Model->raw_sql("
SELECT d.id
FROM device d, asset a, product p, site s
WHERE d.asset_id = a.id
AND a.product_id $p_bind
$crit
GROUP BY d.id
")->{rows};
map { push(@objs, $class->retrieve($_->[0])) } @$rows;
return @objs;
}else{
return $class->SUPER::search_like(%argv);
}
}
############################################################################
=head2 assign_name - Determine and assign correct name to device
This method will try to find or create an appropriate
Resource Record for a Device, given a hostname or ip address,
and optionally a sysname as a backup in case that name or IP do
not resolve.
Arguments:
hash with following keys:
host - hostname or IP address (string)
sysname - System name value from SNMP
Returns:
RR object if successful
Examples:
my $rr = Device->assign_name($host)
=cut
sub assign_name {
my ($class, %argv) = @_;
$class->isa_class_method('assign_name');
my $host = $argv{host};
my $sysname = $argv{sysname};
$class->throw_fatal("Model::Device::assign_name: Missing arguments: host")
unless $host;
# An RR record might already exist
if ( defined $host && (my $rr = RR->search(name=>$host)->first) ){
$logger->debug(sub{"Name $host exists in DB"});
return $rr;
}
# An RR matching $host does not exist, or the name exists in
# multiple zones
my @ips;
if ( Ipblock->matches_ip($host) ){
# we were given an IP address
if ( my $ipb = Ipblock->search(address=>$host)->first ){
if ( $ipb->interface && ( my $dev = $ipb->interface->device ) ){
$logger->debug("Device::assign_name: A Device with IP $host already exists: ".
$dev->get_label);
return $dev->name;
}
}
push @ips, $host;
}else{
# We were given a name (not an address)
# Resolve to an IP address
if ( defined $host && (@ips = Netdot->dns->resolve_name($host)) ){
my $str = join ', ', @ips;
$logger->debug(sub{"Device::assign_name: $host resolves to $str"});
}else{
$logger->debug(sub{"Device::assign_name: $host does not resolve"});
}
}
my $fqdn;
my %args;
my $ip;
if ( @ips ){
# At this point, we were either passed an IP
# or we got one or more from DNS. The idea is to obtain a FQDN
# We'll use the first IP that resolves
foreach my $i ( @ips ){
if ( $fqdn = Netdot->dns->resolve_ip($i) ){
$logger->debug(sub{"Device::assign_name: $i resolves to $fqdn"});
if ( my $rr = RR->search(name=>$fqdn)->first ){
$logger->debug(sub{"Device::assign_name: RR $fqdn already exists in DB"});
return $rr;
}
$ip = $i;
last;
}else{
$logger->debug(sub{"Device::assign_name: $i does not resolve"} );
}
}
}
# At this point, if we haven't got a fqdn, then use the sysname argument, and if not given,
# use the name or IP address passed as the host argument
$fqdn ||= $sysname;
$fqdn ||= $host;
$fqdn = lc($fqdn);
# Check if we have a matching domain
if ( $fqdn =~ /\./ && !Ipblock->matches_ip($fqdn) ){
# Notice that we search the whole string. That's because
# the hostname part might have dots. The Zone search method
# will take care of that.
if ( my $zone = (Zone->search(name=>$fqdn))[0] ){
$args{zone} = $zone->name;
$args{name} = $fqdn;
$args{name} =~ s/\.$args{zone}//;
}else{
$logger->debug(sub{"Device::assign_name: $fqdn not found" });
# Assume the zone to be everything to the right
# of the first dot. This might be a wrong guess
# but it is as close as I can get.
my @sections = split '\.', $fqdn;
$args{name} = shift @sections;
$args{zone} = join '.', @sections;
}
}else{
$args{name} = $fqdn;
}
# Try to create the RR object
# This will also create the Zone object if necessary
my $rr = RR->find_or_create(\%args);
$logger->info(sprintf("Inserted new RR: %s", $rr->get_label));
# Make sure name has an associated IP and A record
if ( $ip ){
my $ipb = Ipblock->search(address=>$ip)->first ||
Ipblock->insert({address=>$ip, status=>'Static'});
my $rraddr = RRADDR->find_or_create({ipblock=>$ipb, rr=>$rr});
}
return $rr;
}
############################################################################
=head2 insert - Insert new Device
We override the insert method for extra functionality:
- More intelligent name assignment
- Assign defaults
- Assign contact lists
Arguments:
Hashref with Device fields and values, plus:
contacts - ContactList object(s) (array or scalar)
Returns:
New Device object
Examples:
my $newdevice = Device->insert(\%args);
=cut
sub insert {
my ($class, $argv) = @_;
$class->isa_class_method('insert');
# name is required
if ( !exists($argv->{name}) ){
$class->throw_fatal('Model::Device::insert: Missing required arguments: name');
}
# Get the default owner entity from config
my $config_owner = Netdot->config->get('DEFAULT_DEV_OWNER');
my $default_owner = Entity->search(name=>$config_owner)->first ||
Entity->search(name=>'Unknown')->first;
# Assign defaults
# These will be overridden by given arguments
my %devtmp = (
community => 'public',
customer_managed => 0,
collect_arp => 0,
collect_fwt => 0,
canautoupdate => 0,
date_installed => $class->timestamp,
monitor_config => 0,
monitored => 0,
owner => $default_owner,
snmp_bulk => $class->config->get('DEFAULT_SNMPBULK'),
snmp_managed => 0,
snmp_polling => 0,
snmp_down => 0,
snmp_conn_attempts => 0,
auto_dns => $class->config->get('DEVICE_IP_NAME_AUTO_UPDATE_DEFAULT'),
);
# Add given args (overrides defaults).
# Extract special arguments that affect the inserted device
my (@contacts, $info);
foreach my $key ( keys %{$argv} ){
if ( $key eq 'contacts' ){
@contacts = $argv->{contacts};
}elsif ( $key eq 'info' ){
$info = $argv->{info};
$devtmp{snmp_managed} = 1;
}else{
$devtmp{$key} = $argv->{$key};
}
}
if ( exists $devtmp{snmp_managed} ){
if ( !$devtmp{snmp_managed} ){
# Means it's being set to 0 or undef
# Turn off other flags
$devtmp{canautoupdate} = 0;
$devtmp{snmp_polling} = 0;
$devtmp{collect_arp} = 0;
$devtmp{collect_fwt} = 0;
}
}
###############################################
# Assign the correct name
# argument 'name' can be passed either as a RR object
# or as a string.
if ( ref($argv->{name}) =~ /RR/ ){
# We are being passed the RR object
$devtmp{name} = $argv->{name};
}else{
# A string hostname was passed
if ( my $rr = RR->search(name=>$argv->{name})->first ){
$devtmp{name} = $rr;
}else{
$devtmp{name} = RR->insert({name=>$argv->{name}});
}
}
if ( my $dbdev = $class->search(name=>$devtmp{name})->first ){
$logger->debug(sprintf("Device::insert: Device %s already exists in DB as %s",
$argv->{name}, $dbdev->fqdn));
return $dbdev;
}
$class->_validate_args(\%devtmp);
my $self = $class->SUPER::insert( \%devtmp );
if ( @contacts ){
$self->add_contact_lists(@contacts);
}else{
$self->add_contact_lists();
}
return $self;
}
############################################################################
=head2 manual_add - Add a device manually
Sets enough information so it can be monitored:
- Creates an interface
- Assigns IP to that interface
- Sets neighbor relationship if possible
Arguments:
host - Name or IP address. Either one will be resolved
Returns:
New Device object
Examples:
my $newdevice = Device->manual_add(host=>"myhost");
=cut
sub manual_add {
my ($class, %argv) = @_;
$class->isa_class_method('manual_add');
# host is required
if ( !exists($argv{host}) ){
$class->throw_fatal('Model::Device::manual_add: Missing required argument: host');
}
# We will try to get both the IP and the name
my ($ip, $name) = Netdot->dns->resolve_any($argv{host});
$name ||= $ip;
my $dev = Device->insert({name=>$name, monitored=>1, snmp_managed=>0,
canautoupdate=>0, auto_dns=>0});
my $ints = $dev->add_interfaces(1);
my $int = $ints->[0];
if ( $ip ){
my $ipb = Ipblock->search(address=>$ip)->first || Ipblock->insert({address=>$ip});
$ipb->update({status=>"Static", interface=>$int, monitored=>1});
$dev->update({snmp_target=>$ipb});
# Try to set the interface neighbor
my $mac = $ipb->get_last_arp_mac();
my $neighbor = $mac->find_edge_port if $mac;
$int->add_neighbor(id=>$neighbor, fixed=>1) if $neighbor;
}
return $dev;
}
############################################################################
=head2 get_snmp_info - SNMP-query a Device for general information
This method can either be called on an existing object, or as a
class method.
Arguments:
Arrayref with the following keys:
host - hostname or IP address (required unless called as object method)
session - SNMP Session (optional)
communities - SNMP communities
version - SNMP version
sec_name - SNMP Security Name
sec_level - SNMP Security Level
auth_proto - SNMP Authentication Protocol
auth_pass - SNMP Auth Key
priv_proto - SNMP Privacy Protocol
priv_pass - SNMP Privacy Key
timeout - SNMP timeout
retries - SNMP retries
bgp_peers - (flag) Retrieve bgp peer info
Returns:
Hash reference containing SNMP information
Examples:
Instance call:
my $info = $device->get_snmp_info();
Class call:
my $info = Device->get_snmp_info(host=>$hostname, communities=>['public']);
=cut
sub get_snmp_info {
my ($self, %args) = @_;
my $class = ref($self) || $self;
my %dev;
my $sinfo = $args{session};
if ( $sinfo ){
$args{host} = $sinfo->{args}->{DestHost};
}else{
if ( ref($self) ){
if ( $self->snmp_target ){
$args{host} = $self->snmp_target->address;
$logger->debug(sub{"Device::get_snmp_info: Using configured target address: $args{host}"});
}else{
$args{host} = $self->fqdn;
}
}else {
$self->throw_fatal('Model::Device::get_snmp_info: Missing required parameters: host')
unless $args{host};
}
# Get SNMP session
my %sess_args;
$sess_args{host} = $args{host};
foreach my $arg ( qw( communities version timeout retries sec_name sec_level
auth_proto auth_pass priv_proto priv_pass) ){
$sess_args{$arg} = $args{$arg} if defined $args{$arg};
}
$sinfo = $self->_get_snmp_session(%sess_args);
return unless $sinfo;
}
$dev{_sclass} = $sinfo->class();
# Assign the snmp_target by resolving the name
# SNMP::Info still does not support IPv6, so for now...
my @ips = Netdot->dns->resolve_name($args{host}, {v4_only=>1});
$dev{snmp_target} = $ips[0] if defined $ips[0];
$logger->debug("Device::get_snmp_info: SNMP target is $dev{snmp_target}");
$dev{snmp_version} = $sinfo->snmp_ver;
$dev{community} = $sinfo->snmp_comm if ( defined $sinfo->snmp_ver && $sinfo->snmp_ver != 3 );
my $name_src = ( $self->config->get('IFNAME_SHORT') eq '1' )?
'orig_i_name' : 'i_description';
push @SMETHODS, $name_src;
if ( $sinfo->can('ipv6_addr_prefix') ){
# This version of SNMP::Info supports fetching IPv6 addresses
push @SMETHODS, qw(ipv6_addr_prefix);
}
if ( $self->config->get('GET_DEVICE_MODULE_INFO') ){
push @SMETHODS, qw( e_index e_type e_parent e_name e_class e_pos e_descr
e_hwver e_fwver e_swver e_model e_serial e_fru);
}
if ( $args{bgp_peers} || $self->config->get('ADD_BGP_PEERS')) {
push @SMETHODS, qw( bgp_peers bgp_peer_id bgp_peer_as bgp_peer_state );
}
my %hashes;
foreach my $method ( @SMETHODS ){
$hashes{$method} = $sinfo->$method;
}
################################################################
# Device's global vars
$dev{layers} = $sinfo->layers;
my $ipf = $sinfo->ipforwarding || 'unknown';
$dev{ipforwarding} = ( $ipf eq 'forwarding') ? 1 : 0;
$dev{sysobjectid} = $sinfo->id;
if ( defined $dev{sysobjectid} ){
$dev{sysobjectid} =~ s/^\.(.*)/$1/; # Remove unwanted first dot
my %IGNORED;
map { $IGNORED{$_}++ } @{ $self->config->get('IGNOREDEVS') };
if ( exists($IGNORED{$dev{sysobjectid}}) ){
$logger->info(sprintf("%s Product id %s ignored per configuration option (IGNOREDEVS)",
$args{host}, $dev{sysobjectid}));
return;
}
}
$dev{model} = $sinfo->model();
$dev{os} = $sinfo->os_ver();
$dev{physaddr} = $sinfo->b_mac() || $sinfo->mac();
$dev{sysname} = $sinfo->name();
$dev{router_id} = $sinfo->root_ip();
$dev{sysdescription} = $sinfo->description();
$dev{syscontact} = $sinfo->contact();
if ( $hashes{'e_descr'} ){
my $first_idx ;
# SNMP::Info::Airespace has stuff like "0.19.26.48.21.32"
# instead of integers. Ideally we would override this
# method in the Netdot::Model::Device::Airespace, but
# for now...
if ( defined $dev{_sclass} && $dev{_sclass} =~ /Airespace/o ){
$first_idx = 1;
}else{
$first_idx = (sort { $a <=> $b } values %{$hashes{'e_index'}})[0];
}
$dev{productname} = $hashes{'e_descr'}->{$first_idx} ;
$dev{part_number} = $hashes{'e_model'}->{$first_idx};
}
$dev{manufacturer} = $sinfo->vendor();
$dev{serial_number} = $sinfo->serial();
$dev{syslocation} = $sinfo->location();
$dev{syslocation} = $class->rem_lt_sp($dev{syslocation}) # Remove white space
if ( $dev{syslocation} );
################################################################
# Get STP (Spanning Tree Protocol) stuff
my $collect_stp = 1;
if ( ref($self) && !$self->collect_stp ){
$collect_stp = 0;
}
if ( $self->config->get('GET_DEVICE_STP_INFO') && $collect_stp ){
if ( defined $dev{physaddr} ){
$dev{stp_type} = $sinfo->stp_ver();
if ( defined $dev{stp_type} && $dev{stp_type} ne 'unknown' ){
# Get STP port id
$hashes{'i_stp_id'} = $sinfo->i_stp_id;
# Store the vlan status
my %vlan_status;
foreach my $vlan ( keys %{$hashes{v_state}} ){
my $vid = $vlan;
$vid =~ s/^1\.//;
$vlan_status{$vid} = $hashes{v_state}->{$vlan};
}
if ( $dev{stp_type} eq 'ieee8021d' || $dev{stp_type} eq 'mst' ){
# Standard values (make it instance 0)
my $stp_p_info = $self->_get_stp_info(sinfo=>$sinfo);
foreach my $method ( keys %$stp_p_info ){
$dev{stp_instances}{0}{$method} = $stp_p_info->{$method};
}
# MST-specific
if ( $dev{stp_type} eq 'mst' ){
# Get MST-specific values
$dev{stp_mst_region} = $sinfo->mst_region_name();
$dev{stp_mst_rev} = $sinfo->mst_region_rev();
$dev{stp_mst_digest} = $sinfo->mst_config_digest();
# Get the mapping of vlans to STP instance
$dev{stp_vlan2inst} = $sinfo->mst_vlan2instance();
my $mapping = join ', ',
map { sprintf("%s=>%s", $_, $dev{stp_vlan2inst}->{$_}) } keys %{$dev{stp_vlan2inst}};
$logger->debug(sub{"Device::get_snmp_info: $args{host} MST VLAN mapping: $mapping"});
# Now, if there's more than one instance, we need to get
# the STP standard info for at least one vlan on that instance.
my %seen_inst;
if ( $sinfo->cisco_comm_indexing() ){
while ( my($vid, $mst_inst) = each %{$dev{stp_vlan2inst}} ){
next if ( exists $seen_inst{$mst_inst} );
next unless $vlan_status{$vid} eq 'operational';
next if ( exists $IGNOREDVLANS{$vid} );
my $stp_p_info;
my $i_stp_info;
eval {
my $vsinfo = $self->_get_cisco_snmp_context_session(sinfo => $sinfo,
vlan => $vid);
return unless $vsinfo;
$stp_p_info = $class->_exec_timeout(
$args{host},
sub{ return $self->_get_stp_info(sinfo=>$vsinfo) }
);
$i_stp_info = $class->_exec_timeout(
$args{host},
sub{ return $self->_get_i_stp_info(sinfo=>$vsinfo) } );
};
if ( my $e = $@ ){
$logger->error("$args{host}: SNMP error for VLAN $vid: $e");
next;
}
foreach my $method ( keys %$stp_p_info ){
$dev{stp_instances}{$mst_inst}{$method} = $stp_p_info->{$method};
}
foreach my $field ( keys %$i_stp_info ){
foreach my $i ( keys %{$i_stp_info->{$field}} ){
$dev{interface}{$i}{$field} = $i_stp_info->{$field}->{$i};
}
}
$seen_inst{$mst_inst} = 1;
}
}
}
}elsif ( $dev{stp_type} =~ /pvst/i ){
# Get stp info for each vlan
# STPInstance numbers match vlan id's
if ( $sinfo->cisco_comm_indexing() ){
my %vlans;
foreach my $p ( keys %{$hashes{'i_vlan_membership'}} ){
my $vlans = $hashes{'i_vlan_membership'}->{$p};
map { $vlans{$_}++ } @$vlans;
}
foreach my $vid ( keys %vlans ){
next if ( exists $IGNOREDVLANS{$vid} );
next unless $vlan_status{$vid} eq 'operational';
eval {
my $vsinfo = $self->_get_cisco_snmp_context_session(sinfo => $sinfo,
vlan => $vid);
return unless $vsinfo;
my $stp_p_info = $class->_exec_timeout(
$args{host},
sub{ return $self->_get_stp_info(sinfo=>$vsinfo) } );
foreach my $method ( keys %$stp_p_info ){
$dev{stp_instances}{$vid}{$method} = $stp_p_info->{$method};
}
my $i_stp_info = $class->_exec_timeout(
$args{host},
sub{ return $self->_get_i_stp_info(sinfo=>$vsinfo) } );
foreach my $field ( keys %$i_stp_info ){
foreach my $i ( keys %{$i_stp_info->{$field}} ){
$dev{interface}{$i}{$field} = $i_stp_info->{$field}->{$i};
}
}
};
if ( my $e = $@ ){
$logger->error("$args{host}: SNMP error for VLAN $vid: $e");
next;
}
}
}
}
}
}
}
# Set some values specific to device types
if ( $dev{ipforwarding} ){
if ( my $local_as = $sinfo->bgp_local_as() ){
my $asn = ASN->find_or_create({number=>$local_as});
$dev{bgplocalas} = $asn;
}
$dev{bgpid} = $sinfo->bgp_id();
}
################################################################
# CDP/LLDP stuff
if (( $hashes{hasCDP} ) or ($hashes{hasLLDP})){
# Call all the relevant methods
my %dp_hashes;
my @dp_methods = qw ( c_id c_ip c_port c_platform );
foreach my $m ( @dp_methods ){
$dp_hashes{$m} = $sinfo->$m;
}
# Translate keys into iids
my $c_ifs = $sinfo->c_if();
while ( my ($key, $iid) = each %$c_ifs ){
next unless $iid;
foreach my $m ( @dp_methods ){
next if !exists $dp_hashes{$m}->{$key};
my $v = $dp_hashes{$m}->{$key};
# Ignore values with non-ascii chars
next unless $self->is_ascii($v);
# SNMP::Info can include values from both LLDP and CDP
# which means that for each port, we can have different
# values. We save them all in a comma-separated list
if ( exists $hashes{$m}->{$iid} ){
# Use a hash for fast lookup
my %vals;
map { $vals{$_} = 1 } split ';', $hashes{$m}->{$iid};
if ( ! exists $vals{$dp_hashes{$m}->{$key}} ){
# Append new value to list
$vals{$v} = 1;