mirror/librenms-librenms
1
0
Fork 0
mirror of https://github.com/librenms/librenms.git synced 2024-10-07 16:52:45 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

refactor: Discovery protocols re-write (#7380)

Browse Source 
* refactor: discovery protocols re-write
extract more code to make it easier to read
use snmpwalk_group
walk lldpRemTable instead of lldpRemoteSystemsData
Optimize discover_device to reduce dns lookups of bad dns names
Make discovery_by_ip behavior consistent between cdp and lldp
move can_skip_discovery to discovery functions

Tested lldp, cdp, and ospf.

* always discover links even if the remote device isn't in system
Fix discover_link always updating

* fix style

* fix update, not fetching id

* increase platform length.  Most devices use sysDescr here, which is max length 255

* remove orphaned links

* update db_schema.yaml
This commit is contained in:
Tony Murray
2017-10-04 02:16:23 -05:00
committed by Neil Lathwood
parent a1d782613b
commit c0b267b49c
7 changed files with 410 additions and 266 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
LibreNMS/Util/IP.php
View File

@@ -138,6 +138,23 @@ abstract class IP
*/
abstract public function inNetwork($network);
/**
* Check if this IP is in one of multiple networks
*
* @param array $networks
* @return bool
*/
public function inNetworks($networks)
{
foreach ((array)$networks as $network) {
if ($this->inNetwork($network)) {
return true;
}
}
return false;
}
/**
* Check if this IP is in the reserved range.
* @return bool
@@ -167,6 +184,16 @@ abstract class IP
return (string)$this->ip;
}
/**
* Packed address for storage in database
*
* return string
*/
public function packed()
{
return inet_pton((string)$this->ip);
}
/**
* Get the family of this IP.
* @return string ipv4 or ipv6

2
includes/common.php
View File

@@ -627,7 +627,7 @@ function is_valid_hostname($hostname)
// white space are permitted. While a hostname may not contain other characters,
// such as the underscore character (_), other DNS names may contain the underscore
return ctype_alnum(str_replace('_', '', str_replace('-', '', str_replace('.', '', $hostname))));
return ctype_alnum(str_replace(array('_', '-', '.'), '', $hostname));
}
/*

368
includes/discovery/discovery-protocols.inc.php
View File

@@ -1,236 +1,227 @@
<?php
global $link_exists;
use LibreNMS\Config;
use LibreNMS\Util\IP;
$community = $device['community'];
global $link_exists;
if ($device['os'] == 'ironware' && Config::get('autodiscovery.xdp') === true) {
echo ' Brocade FDP: ';
$fdp_array = snmpwalk_cache_twopart_oid($device, 'snFdpCacheEntry', array(), 'FOUNDRY-SN-SWITCH-GROUP-MIB');
d_echo($fdp_array);
if ($fdp_array) {
unset($fdp_links);
foreach ($fdp_array as $key => $fdp_if_array) {
$interface = get_port_by_ifIndex($device['device_id'], $key);
d_echo($fdp_if_array);
foreach ($fdp_if_array as $entry_key => $fdp) {
$remote_device_id = dbFetchCell('SELECT `device_id` FROM `devices` WHERE `sysName` = ? OR `hostname` = ?', array($fdp['snFdpCacheDeviceId'], $fdp['snFdpCacheDeviceId']));
$fdp_array = snmpwalk_group($device, 'snFdpCacheEntry', 'FOUNDRY-SN-SWITCH-GROUP-MIB', 2);
if (!$remote_device_id &&
!can_skip_discovery(Config::get('autodiscovery.xdp_exclude.sysname_regexp'), $fdp['snFdpCacheDeviceId'], $fdp['snFdpCacheDeviceId']) &&
!can_skip_discovery(Config::get('autodiscovery.xdp_exclude.sysdesc_regexp'), $fdp['snFdpCacheVersion'], $fdp['snFdpCacheDeviceId'])
) {
$remote_device_id = discover_new_device($fdp['snFdpCacheDeviceId'], $device, 'FDP', $interface);
}
foreach ($fdp_array as $key => $fdp_if_array) {
$interface = get_port_by_ifIndex($device['device_id'], $key);
d_echo($fdp_if_array);
if ($remote_device_id) {
$if = $fdp['snFdpCacheDevicePort'];
$remote_port_id = dbFetchCell('SELECT port_id FROM `ports` WHERE (`ifDescr` = ? OR `ifName` = ?) AND `device_id` = ?', array($if, $if, $remote_device_id));
} else {
$remote_port_id = '0';
}
foreach ($fdp_if_array as $entry_key => $fdp) {
$remote_device_id = find_device_id($fdp['snFdpCacheDeviceId']);
discover_link($interface['port_id'], $fdp['snFdpCacheVendorId'], $remote_port_id, $fdp['snFdpCacheDeviceId'], $fdp['snFdpCacheDevicePort'], $fdp['snFdpCachePlatform'], $fdp['snFdpCacheVersion'], $device['device_id'], $remote_device_id);
if (!$remote_device_id &&
!can_skip_discovery($fdp['snFdpCacheDeviceId'], $fdp['snFdpCacheVersion'])
) {
$remote_device_id = discover_new_device($fdp['snFdpCacheDeviceId'], $device, 'FDP', $interface);
}
}//end foreach
}//end if
$remote_port_id = find_port_id($fdp['snFdpCacheDevicePort'], '', $remote_device_id);
discover_link(
$interface['port_id'],
$fdp['snFdpCacheVendorId'],
$remote_port_id,
$fdp['snFdpCacheDeviceId'],
$fdp['snFdpCacheDevicePort'],
$fdp['snFdpCachePlatform'],
$fdp['snFdpCacheVersion'],
$device['device_id'],
$remote_device_id
);
}
}//end foreach
echo PHP_EOL;
}//end if
echo ' CISCO-CDP-MIB: ';
unset($cdp_array);
if (Config::get('autodiscovery.xdp') === true) {
$cdp_array = snmpwalk_cache_twopart_oid($device, 'cdpCache', array(), 'CISCO-CDP-MIB');
d_echo($cdp_array);
if ($cdp_array) {
unset($cdp_links);
foreach ($cdp_array as $key => $cdp_if_array) {
$interface = get_port_by_ifIndex($device['device_id'], $key);
d_echo($cdp_if_array);
foreach ($cdp_if_array as $entry_key => $cdp) {
if (is_valid_hostname($cdp['cdpCacheDeviceId']) || Config::get('discovery_by_ip', false)) {
$cdp_ip = IP::fromHexString($cdp['cdpCacheAddress'], true);
$remote_device_id = dbFetchCell('SELECT `device_id` FROM `devices` WHERE `sysName` = ? OR `hostname` = ? OR `hostname` = ?', array($cdp['cdpCacheDeviceId'], $cdp['cdpCacheDeviceId'], $cdp_ip));
$cdp_array = snmpwalk_group($device, 'cdpCache', 'CISCO-CDP-MIB', 2);
if (!$remote_device_id &&
!can_skip_discovery(Config::get('autodiscovery.cdp_exclude.platform_regexp'), $cdp['cdpCachePlatform'], $cdp['cdpCacheDeviceId']) &&
!can_skip_discovery(Config::get('autodiscovery.xdp_exclude.sysname_regexp'), $cdp['cdpCacheDeviceId'], $cdp['cdpCacheDeviceId']) &&
!can_skip_discovery(Config::get('autodiscovery.xdp_exclude.sysdesc_regexp'), $cdp['cdpCacheVersion'], $cdp['cdpCacheDeviceId'])
) {
if (Config::get('discovery_by_ip', false)) {
$remote_device_id = discover_new_device($cdp_ip, $device, 'CDP', $interface);
} else {
$remote_device_id = discover_new_device($cdp['cdpCacheDeviceId'], $device, 'CDP', $interface);
}
}
foreach ($cdp_array as $key => $cdp_if_array) {
$interface = get_port_by_ifIndex($device['device_id'], $key);
if ($remote_device_id) {
$if = $cdp['cdpCacheDevicePort'];
$remote_port_id = dbFetchCell('SELECT port_id FROM `ports` WHERE (`ifDescr` = ? OR `ifName` = ?) AND `device_id` = ?', array($if, $if, $remote_device_id));
} else {
$remote_port_id = '0';
}
foreach ($cdp_if_array as $entry_key => $cdp) {
d_echo($cdp);
if ($interface['port_id'] && $cdp['cdpCacheDeviceId'] && $cdp['cdpCacheDevicePort']) {
discover_link($interface['port_id'], 'cdp', $remote_port_id, $cdp['cdpCacheDeviceId'], $cdp['cdpCacheDevicePort'], $cdp['cdpCachePlatform'], $cdp['cdpCacheVersion'], $device['device_id'], $remote_device_id);
}
} else {
echo 'X';
}//end if
}//end foreach
$cdp_ip = IP::fromHexString($cdp['cdpCacheAddress'], true);
$remote_device_id = find_device_id($cdp['cdpCacheDeviceId'], $cdp_ip);
if (!$remote_device_id &&
!can_skip_discovery($cdp['cdpCacheDeviceId'], $cdp['cdpCacheVersion'], $cdp['cdpCachePlatform'])
) {
$remote_device_id = discover_new_device($cdp['cdpCacheDeviceId'], $device, 'CDP', $interface);
if (!$remote_device_id && Config::get('discovery_by_ip', false)) {
$remote_device_id = discover_new_device($cdp_ip, $device, 'CDP', $interface);
}
}
if ($interface['port_id'] && $cdp['cdpCacheDeviceId'] && $cdp['cdpCacheDevicePort']) {
$remote_port_id = find_port_id($cdp['cdpCacheDevicePort'], '', $remote_device_id);
discover_link(
$interface['port_id'],
'cdp',
$remote_port_id,
$cdp['cdpCacheDeviceId'],
$cdp['cdpCacheDevicePort'],
$cdp['cdpCachePlatform'],
$cdp['cdpCacheVersion'],
$device['device_id'],
$remote_device_id
);
}
}//end foreach
}//end if
}//end foreach
echo PHP_EOL;
}//end if
unset(
$lldp_array,
$cdp_array
);
if ($device['os'] == 'pbn' && Config::get('autodiscovery.xdp') === true) {
echo ' NMS-LLDP-MIB: ';
$lldp_array = snmpwalk_cache_oid($device, 'lldpRemoteSystemsData', array(), 'NMS-LLDP-MIB', 'pbn');
d_echo($lldp_array);
if ($lldp_array) {
unset($lldp_links);
foreach ($lldp_array as $key => $lldp) {
d_echo($lldp);
$interface = get_port_by_ifIndex($device['device_id'], $lldp['lldpRemLocalPortNum']);
$remote_device_id = dbFetchCell('SELECT `device_id` FROM `devices` WHERE `sysName` = ? OR `hostname` = ?', array($lldp['lldpRemSysName'], $lldp['lldpRemSysName']));
$lldp_array = snmpwalk_group($device, 'lldpRemoteSystemsData', 'NMS-LLDP-MIB');
if (!$remote_device_id &&
is_valid_hostname($lldp['lldpRemSysName']) &&
!can_skip_discovery(Config::get('autodiscovery.xdp_exclude.sysname_regexp'), $lldp['lldpRemSysName'], $lldp['lldpRemSysName']) &&
!can_skip_discovery(Config::get('autodiscovery.xdp_exclude.sysdesc_regexp'), $lldp['lldpRemSysDesc'], $lldp['lldpRemSysName'])
) {
$remote_device_id = discover_new_device($lldp['lldpRemSysName'], $device, 'LLDP', $interface);
}
foreach ($lldp_array as $key => $lldp) {
d_echo($lldp);
$interface = get_port_by_ifIndex($device['device_id'], $lldp['lldpRemLocalPortNum']);
$remote_device_id = find_device_id($lldp['lldpRemSysName']);
if ($remote_device_id) {
$if = $lldp['lldpRemPortDesc'];
$id = $lldp['lldpRemPortId'];
$remote_port_id = dbFetchCell('SELECT `port_id` FROM `ports` WHERE (`ifDescr` = ? OR `ifName` = ? OR `ifDescr` = ? OR `ifName` = ?) AND `device_id` = ?', array($if, $if, $id, $id, $remote_device_id));
} else {
$remote_port_id = '0';
}
if (!$remote_device_id &&
is_valid_hostname($lldp['lldpRemSysName']) &&
!can_skip_discovery($lldp['lldpRemSysName'], $lldp['lldpRemSysDesc'])
) {
$remote_device_id = discover_new_device($lldp['lldpRemSysName'], $device, 'LLDP', $interface);
}
if (is_numeric($interface['port_id']) && isset($lldp['lldpRemSysName']) && isset($lldp['lldpRemPortId'])) {
discover_link($interface['port_id'], 'lldp', $remote_port_id, $lldp['lldpRemSysName'], $lldp['lldpRemPortId'], null, $lldp['lldpRemSysDesc'], $device['device_id'], $remote_device_id);
}
}//end foreach
}//end if
if ($interface['port_id'] && $lldp['lldpRemSysName'] && $lldp['lldpRemPortId']) {
$remote_port_id = find_port_id($lldp['lldpRemPortDesc'], $lldp['lldpRemPortId'], $remote_device_id);
discover_link(
$interface['port_id'],
'lldp',
$remote_port_id,
$lldp['lldpRemSysName'],
$lldp['lldpRemPortId'],
null,
$lldp['lldpRemSysDesc'],
$device['device_id'],
$remote_device_id
);
}
}//end foreach
echo PHP_EOL;
} elseif (Config::get('autodiscovery.xdp') === true) {
echo ' LLDP-MIB: ';
$lldp_array = snmpwalk_cache_threepart_oid($device, 'lldpRemoteSystemsData', array(), 'LLDP-MIB');
d_echo($lldp_array);
$dot1d_array = snmpwalk_cache_oid($device, 'dot1dBasePortIfIndex', array(), 'BRIDGE-MIB');
d_echo($dot1d_array);
if ($lldp_array) {
$lldp_links = '';
foreach ($lldp_array as $key => $lldp_if_array) {
d_echo($lldp_if_array);
foreach ($lldp_if_array as $entry_key => $lldp_instance) {
if (is_numeric($dot1d_array[$entry_key]['dot1dBasePortIfIndex'])) {
$ifIndex = $dot1d_array[$entry_key]['dot1dBasePortIfIndex'];
} else {
$ifIndex = $entry_key;
$lldp_array = snmpwalk_group($device, 'lldpRemTable', 'LLDP-MIB', 3);
if (!empty($lldp_array)) {
$dot1d_array = snmpwalk_group($device, 'dot1dBasePortIfIndex', 'BRIDGE-MIB');
}
foreach ($lldp_array as $key => $lldp_if_array) {
foreach ($lldp_if_array as $entry_key => $lldp_instance) {
if (is_numeric($dot1d_array[$entry_key]['dot1dBasePortIfIndex'])) {
$ifIndex = $dot1d_array[$entry_key]['dot1dBasePortIfIndex'];
} else {
$ifIndex = $entry_key;
}
$interface = get_port_by_ifIndex($device['device_id'], $ifIndex);
d_echo($lldp_instance);
foreach ($lldp_instance as $entry_instance => $lldp) {
// normalize MAC address if present
$remote_port_mac = '';
if ($lldp['lldpRemPortIdSubtype'] == 3) { // 3 = macaddress
$remote_port_mac = str_replace(array(' ', ':', '-'), '', strtolower($lldp['lldpRemPortId']));
}
$interface = get_port_by_ifIndex($device['device_id'], $ifIndex);
d_echo($lldp_instance);
foreach ($lldp_instance as $entry_instance => $lldp) {
$remote_device_id = dbFetchCell('SELECT `device_id` FROM `devices` WHERE `sysName` = ? OR `hostname` = ?', array($lldp['lldpRemSysName'], $lldp['lldpRemSysName']));
$remote_device_id = find_device_id($lldp['lldpRemSysName'], $lldp['lldpRemManAddr'], $remote_port_mac);
if (!$remote_device_id && is_valid_hostname($lldp['lldpRemSysName'])) {
if (!can_skip_discovery(Config::get('autodiscovery.xdp_exclude.sysname_regexp'), $lldp['lldpRemSysName'], $lldp['lldpRemSysName']) &&
!can_skip_discovery(Config::get('autodiscovery.xdp_exclude.sysdesc_regexp'), $lldp['lldpRemSysDesc'], $lldp['lldpRemSysName'])
) {
$remote_device_id = discover_new_device($lldp['lldpRemSysName'], $device, 'LLDP', $interface);
if (is_numeric($remote_device_id) === false) {
$ptopo_array = snmpwalk_cache_oid($device, 'ptopoConnEntry', array(), 'PTOPO-MIB');
d_echo($ptopo_array);
foreach ($ptopo_array as $ptopo) {
if (strcmp(trim($ptopo['ptopoConnRemoteChassis']), trim($lldp['lldpRemChassisId'])) == 0) {
$discover_hostname = IP::fromHexString($ptopo['ptopoConnAgentNetAddr'], true);
break;
}
}
unset(
$ptopo_array,
$ip_arr
);
// add device if configured to do so
if (!$remote_device_id && !can_skip_discovery($lldp['lldpRemSysName'], $lldp['lldpRemSysDesc'])) {
$remote_device_id = discover_new_device($lldp['lldpRemSysName'], $device, 'LLDP', $interface);
if (!$remote_device_id && Config::get('discovery_by_ip', false)) {
$ptopo_array = snmpwalk_group($device, 'ptopoConnEntry', 'PTOPO-MIB');
d_echo($ptopo_array);
foreach ($ptopo_array as $ptopo) {
if (strcmp(trim($ptopo['ptopoConnRemoteChassis']), trim($lldp['lldpRemChassisId'])) == 0) {
$ip = IP::fromHexString($ptopo['ptopoConnAgentNetAddr'], true);
$remote_device_id = discover_new_device($ip, $device, 'LLDP', $interface);
break;
}
d_echo("Discovering $discover_hostname\n");
$remote_device_id = discover_new_device($discover_hostname, $device, 'LLDP', $interface);
}
unset($ptopo_array);
}
// normalize MAC address if present
$remote_port_mac_address = '';
if ($lldp['lldpRemPortIdSubtype'] == 'macAddress') {
$remote_port_mac_address = str_replace(array(' ', ':', '-'), '', strtolower($lldp['lldpRemPortId']));
}
// get remote device hostname from db by MAC address and replace lldpRemSysName if absent
if (!$remote_device_id && $remote_port_mac_address) {
$remote_device_id = dbFetchCell('SELECT `device_id` FROM `ports` WHERE ifPhysAddress = ? AND `deleted` = ?', array($remote_port_mac_address, '0'));
if ($remote_device_id) {
$remote_device_hostname = dbFetchRow('SELECT `hostname` FROM `devices` WHERE `device_id` = ?', array($remote_device_id));
}
if ($remote_device_hostname['hostname']) {
$lldp['lldpRemSysName'] = $remote_device_hostname['hostname'];
}
}
if ($remote_device_id) {
$if = $lldp['lldpRemPortDesc'];
$id = $lldp['lldpRemPortId'];
$remote_port_id = dbFetchCell('SELECT `port_id` FROM `ports` WHERE (`ifDescr` = ? OR `ifName` = ? OR `ifDescr` = ? OR `ifName` = ? OR `ifPhysAddress` = ?) AND `device_id` = ?', array($if, $if, $id, $id, $remote_port_mac_address, $remote_device_id));
} else {
$remote_port_id = '0';
}
if (is_numeric($interface['port_id']) && isset($lldp['lldpRemSysName']) && isset($lldp['lldpRemPortId'])) {
discover_link($interface['port_id'], 'lldp', $remote_port_id, $lldp['lldpRemSysName'], $lldp['lldpRemPortId'], null, $lldp['lldpRemSysDesc'], $device['device_id'], $remote_device_id);
}
}//end foreach
}
$remote_port_id = find_port_id(
$lldp['lldpRemPortDesc'],
$lldp['lldpRemPortId'],
$remote_device_id,
$remote_port_mac
);
if (empty($lldp['lldpRemSysName'])) {
$remote_device = device_by_id_cache($remote_device_id);
$lldp['lldpRemSysName'] = $remote_device['sysName'] ?: $remote_device['hostname'];
}
if ($interface['port_id'] && $lldp['lldpRemSysName'] && $lldp['lldpRemPortId']) {
discover_link(
$interface['port_id'],
'lldp',
$remote_port_id,
$lldp['lldpRemSysName'],
$lldp['lldpRemPortId'],
null,
$lldp['lldpRemSysDesc'],
$device['device_id'],
$remote_device_id
);
}
}//end foreach
}//end foreach
}//end if
}//end foreach
unset(
$dot1d_array
);
echo PHP_EOL;
}//end elseif
unset(
$lldp_array
);
echo ' OSPF Discovery: ';
if (Config::get('autodiscovery.ospf') === true) {
echo "enabled\n";
foreach (dbFetchRows('SELECT DISTINCT(`ospfNbrIpAddr`),`device_id` FROM `ospf_nbrs` WHERE `device_id`=?', array($device['device_id'])) as $nbr) {
$ip = $nbr['ospfNbrIpAddr'];
if (match_network(Config::get('autodiscovery.nets-exclude'), $ip)) {
echo 'x';
continue;
}
echo ' OSPF Discovery: ';
$sql = 'SELECT DISTINCT(`ospfNbrIpAddr`),`device_id` FROM `ospf_nbrs` WHERE `device_id`=?';
foreach (dbFetchRows($sql, array($device['device_id'])) as $nbr) {
try {
$ip = IP::parse($nbr['ospfNbrIpAddr']);
if (!match_network(Config::get('nets'), $ip)) {
echo 'i';
continue;
}
if ($ip->inNetworks(Config::get('autodiscovery.nets-exclude'))) {
echo 'x';
continue;
}
$name = gethostbyaddr($ip);
$remote_device_id = discover_new_device($name, $device, 'OSPF');
if (!$ip->inNetworks(Config::get('nets'))) {
echo 'i';
continue;
}
$name = gethostbyaddr($ip);
$remote_device_id = discover_new_device($name, $device, 'OSPF');
} catch (\LibreNMS\Exceptions\InvalidIpException $e) {
//
}
}
} else {
echo "disabled\n";
echo PHP_EOL;
}
d_echo($link_exists);
$sql = "SELECT * FROM `links` AS L, `ports` AS I WHERE L.local_port_id = I.port_id AND I.device_id = '".$device['device_id']."'";
foreach (dbFetchRows($sql) as $test) {
$sql = "SELECT * FROM `links` AS L, `ports` AS I WHERE L.local_port_id = I.port_id AND I.device_id = ?";
foreach (dbFetchRows($sql, array($device['device_id'])) as $test) {
$local_port_id = $test['local_port_id'];
$remote_hostname = $test['remote_hostname'];
$remote_port = $test['remote_port'];
@@ -243,8 +234,15 @@ foreach (dbFetchRows($sql) as $test) {
}
}
// remove orphaned links
$deleted = dbQuery('DELETE `l` FROM `links` `l` LEFT JOIN `devices` `d` ON `d`.`device_id` = `l`.`local_device_id` WHERE `d`.`device_id` IS NULL');
echo str_repeat('-', $deleted);
d_echo(" $deleted orphaned links deleted\n");
unset(
$link_exists,
$sql
$sql,
$fdp_array,
$cdp_array,
$lldp_array
);
echo "\n";

257
includes/discovery/functions.inc.php
View File

@@ -14,77 +14,83 @@
use LibreNMS\Config;
use LibreNMS\Exceptions\HostExistsException;
use LibreNMS\Exceptions\InvalidIpException;
use LibreNMS\Util\IP;
use LibreNMS\Util\IPv6;
function discover_new_device($hostname, $device = '', $method = '', $interface = '')
{
if (Config::has('mydomain')) {
$full_host = rtrim($hostname, '.') . '.' . Config::get('mydomain');
if (isDomainResolves($full_host)) {
$hostname = $full_host;
}
}
d_echo("discovering $hostname\n");
$ip = gethostbyname($hostname);
if (filter_var($ip, FILTER_VALIDATE_IP, FILTER_FLAG_IPV4) === false && filter_var($ip, FILTER_VALIDATE_IP, FILTER_FLAG_IPV6) === false) {
// $ip isn't a valid IP so it must be a name.
if ($ip == $hostname) {
d_echo("name lookup of $hostname failed\n");
log_event("$method discovery of " . $hostname . " failed - Check name lookup", $device['device_id'], 'discovery', 5);
return false;
}
} elseif (filter_var($hostname, FILTER_VALIDATE_IP, FILTER_FLAG_IPV4) === true || filter_var($hostname, FILTER_VALIDATE_IP, FILTER_FLAG_IPV6) === true) {
// gethostbyname returned a valid $ip, was $dst_host an IP?
if (IP::isValid($hostname)) {
$ip = $hostname;
if (!Config::get('discovery_by_ip', false)) {
d_echo('Discovery by IP disabled, skipping ' . $hostname);
log_event("$method discovery of " . $hostname . " failed - Discovery by IP disabled", $device['device_id'], 'discovery', 4);
return false;
}
} elseif (is_valid_hostname($hostname)) {
if ($mydomain = Config::get('mydomain')) {
$full_host = rtrim($hostname, '.') . '.' . $mydomain;
if (isDomainResolves($full_host)) {
$hostname = $full_host;
}
}
$ip = gethostbyname($hostname);
if ($ip == $hostname) {
d_echo("name lookup of $hostname failed\n");
log_event("$method discovery of " . $hostname . " failed - Check name lookup", $device['device_id'], 'discovery', 5);
return false;
}
} else {
d_echo("Discovery failed: '$hostname' is not a valid ip or dns name\n");
return false;
}
d_echo("ip lookup result: $ip\n");
$hostname = rtrim($hostname, '.');
// remove trailing dot
if (match_network(Config::get('autodiscovery.nets-exclude'), $ip)) {
d_echo("$ip in an excluded network - skipping\n");
$hostname = rtrim($hostname, '.'); // remove trailing dot
$ip = IP::parse($ip, true);
if ($ip->inNetworks(Config::get('autodiscovery.nets-exclude'))) {
d_echo("$ip in an excluded network - skipping\n");
return false;
}
if (match_network(Config::get('nets'), $ip)) {
try {
$remote_device_id = addHost($hostname, '', '161', 'udp', Config::get('distributed_poller_group'));
$remote_device = device_by_id_cache($remote_device_id, 1);
echo '+[' . $remote_device['hostname'] . '(' . $remote_device['device_id'] . ')]';
discover_device($remote_device);
device_by_id_cache($remote_device_id, 1);
if ($remote_device_id && is_array($device) && !empty($method)) {
$extra_log = '';
$int = cleanPort($interface);
if (is_array($int)) {
$extra_log = ' (port ' . $int['label'] . ') ';
}
if (!$ip->inNetworks(Config::get('nets'))) {
d_echo("$ip not in a matched network - skipping\n");
return false;
}
log_event('Device ' . $remote_device['hostname'] . " ($ip) $extra_log autodiscovered through $method on " . $device['hostname'], $remote_device_id, 'discovery', 1);
} else {
log_event("$method discovery of " . $remote_device['hostname'] . " ($ip) failed - Check ping and SNMP access", $device['device_id'], 'discovery', 5);
try {
$remote_device_id = addHost($hostname, '', '161', 'udp', Config::get('distributed_poller_group'));
$remote_device = device_by_id_cache($remote_device_id, 1);
echo '+[' . $remote_device['hostname'] . '(' . $remote_device['device_id'] . ')]';
discover_device($remote_device);
device_by_id_cache($remote_device_id, 1);
if ($remote_device_id && is_array($device) && !empty($method)) {
$extra_log = '';
$int = cleanPort($interface);
if (is_array($int)) {
$extra_log = ' (port ' . $int['label'] . ') ';
}
return $remote_device_id;
} catch (HostExistsException $e) {
// already have this device
} catch (Exception $e) {
log_event("$method discovery of " . $hostname . " ($ip) failed - " . $e->getMessage(), $device['device_id'], 'discovery', 5);
log_event('Device ' . $remote_device['hostname'] . " ($ip) $extra_log autodiscovered through $method on " . $device['hostname'], $remote_device_id, 'discovery', 1);
} else {
log_event("$method discovery of " . $remote_device['hostname'] . " ($ip) failed - Check ping and SNMP access", $device['device_id'], 'discovery', 5);
}
} else {
d_echo("$ip not in a matched network - skipping\n");
}//end if
return $remote_device_id;
} catch (HostExistsException $e) {
// already have this device
} catch (Exception $e) {
log_event("$method discovery of " . $hostname . " ($ip) failed - " . $e->getMessage(), $device['device_id'], 'discovery', 5);
}
return false;
}
//end discover_new_device()
@@ -538,22 +544,24 @@ function discover_link($local_port_id, $protocol, $remote_port_id, $remote_hostn
echo '+';
d_echo("( $inserted inserted )");
} else {
$data = dbFetchRow('SELECT * FROM `links` WHERE `remote_hostname` = ? AND `local_port_id` = ? AND `protocol` = ? AND `remote_port` = ?', array($remote_hostname, $local_port_id, $protocol, $remote_port));
if ($data['remote_port_id'] == $remote_port_id && $data['remote_platform'] == $remote_platform && $remote_version == $remote_version && $data['local_device_id'] > 0 && $data['remote_device_id'] > 0) {
$sql = 'SELECT `id`,`local_device_id`,`remote_platform`,`remote_version`,`remote_device_id`,`remote_port_id` FROM `links`';
$sql .= ' WHERE `remote_hostname` = ? AND `local_port_id` = ? AND `protocol` = ? AND `remote_port` = ?';
$data = dbFetchRow($sql, array($remote_hostname, $local_port_id, $protocol, $remote_port));
$update_data = array(
'local_device_id' => $local_device_id,
'remote_platform' => $remote_platform,
'remote_version' => $remote_version,
'remote_device_id' => $remote_device_id,
'remote_port_id' => $remote_port_id
);
$id = $data['id'];
unset($data['id']);
if ($data == $update_data) {
echo '.';
} else {
$update_data = array(
'remote_platform' => $remote_platform,
'remote_version' => $remote_version,
'local_device_id' => $local_device_id,
'remote_device_id' => $remote_device_id,
);
if (!empty($remote_port_id)) {
$update_data['remote_port_id'] = $remote_port_id;
}
$updated = dbUpdate($update_data, 'links', '`id` = ?', array($data['id']));
$updated = dbUpdate($update_data, 'links', '`id` = ?', array($id));
echo 'U';
d_echo("( $updated updated )");
}//end if
@@ -1310,3 +1318,132 @@ function add_cbgp_peer($device, $peer, $afi, $safi)
dbInsert($cbgp, 'bgpPeers_cbgp');
}
}
/**
* check if we should skip this device from discovery
* @param string $sysName
* @param string $sysDescr
* @param string $platform
* @return bool
*/
function can_skip_discovery($sysName, $sysDescr = '', $platform = '')
{
if ($sysName) {
foreach ((array)Config::get('autodiscovery.xdp_exclude.sysname_regexp') as $needle) {
if (preg_match($needle .'i', $sysName)) {
d_echo("$sysName - regexp '$needle' matches '$sysName' - skipping device discovery \n");
return true;
}
}
}
if ($sysDescr) {
foreach ((array)Config::get('autodiscovery.xdp_exclude.sysdesc_regexp') as $needle) {
if (preg_match($needle .'i', $sysDescr)) {
d_echo("$sysName - regexp '$needle' matches '$sysDescr' - skipping device discovery \n");
return true;
}
}
}
if ($platform) {
foreach ((array)Config::get('autodiscovery.cdp_exclude.platform_regexp') as $needle) {
if (preg_match($needle .'i', $platform)) {
d_echo("$sysName - regexp '$needle' matches '$platform' - skipping device discovery \n");
return true;
}
}
}
return false;
}
/**
* Try to find a device by sysName, hostname, ip, or mac_address
* If a device cannot be found, returns 0
*
* @param string $name sysName or hostname
* @param string $ip May be an IP or hex string
* @param string $mac_address
* @return int the device_id or 0
*/
function find_device_id($name = '', $ip = '', $mac_address = '')
{
$where = array();
$params = array();
if ($name && is_valid_hostname($name)) {
$where[] = '`sysName`=?';
$params[] = $name;
$where[] = '`hostname`=?';
$params[] = $name;
if ($mydomain = Config::get('mydomain')) {
$where[] = '`hostname`=?';
$params[] = "$name.$mydomain";
}
}
if ($ip) {
$where[] = '`hostname`=?';
$params[] = $ip;
try {
$params[] = IP::fromHexString($ip)->packed();
$where[] = '`ip`=?';
} catch (InvalidIpException $e) {
//
}
}
if (!empty($where)) {
$sql = 'SELECT `device_id` FROM `devices` WHERE ' . implode(' OR ', $where);
if ($device_id = dbFetchCell($sql, $params)) {
return (int)$device_id;
}
}
if ($mac_address && $mac_address != '000000000000') {
if ($device_id = dbFetchCell('SELECT `device_id` FROM `ports` WHERE `ifPhysAddress`=?', array($mac_address))) {
return (int)$device_id;
}
}
return 0;
}
/**
* Try to find a port by ifDescr, ifName, or MAC
*
* @param string $description matched against ifDescr and ifName
* @param string $identifier matched against ifDescr and ifName
* @param int $device_id restrict search to ports on a specific device
* @param string $mac_address check against ifPysAddress (should be in lowercase hexadecimal)
* @return int
*/
function find_port_id($description, $identifier = '', $device_id = 0, $mac_address = null)
{
$sql = 'SELECT `port_id` FROM `ports` WHERE (`ifDescr`=? OR `ifName`=?';
$params = array($description, $description);
if ($identifier) {
$sql .= ' OR `ifDescr`=? OR `ifName`=?';
$params[] = $identifier;
$params[] = $identifier;
}
if ($mac_address) {
$sql .= ' OR `ifPhysAddress`=?';
$params[] = $mac_address;
}
$sql .= ')';
if ($device_id) {
$sql .= ' AND `device_id`=?';
$params = $device_id;
}
return (int)dbFetchCell($sql, $params);
}

19
includes/functions.php
View File

@@ -1919,25 +1919,6 @@ function get_toner_levels($device, $raw_value, $capacity)
return round($raw_value / $capacity * 100);
}
/**
* check if we should skip this device from discovery
* @param $needles
* @param $haystack
* @param $name
* @return bool
*/
function can_skip_discovery($needles, $haystack, $name)
{
foreach ((array)$needles as $needle) {
if (preg_match($needle ."i", $haystack)) {
d_echo("{$name} - regexp '{$needle}' matches '{$haystack}' - skipping device discovery \n");
return true;
}
}
return false;
}
/**
* Intialize global stat arrays
*/

2
misc/db_schema.yaml
View File

@@ -682,7 +682,7 @@ links:
protocol: { Field: protocol, Type: varchar(11), 'Null': true, Default: 'NULL', Extra: '' }
remote_device_id: { Field: remote_device_id, Type: int(11), 'Null': false, Default: 'NULL', Extra: '' }
remote_hostname: { Field: remote_hostname, Type: varchar(128), 'Null': false, Default: 'NULL', Extra: '' }
remote_platform: { Field: remote_platform, Type: varchar(128), 'Null': false, Default: 'NULL', Extra: '' }
remote_platform: { Field: remote_platform, Type: varchar(256), 'Null': true, Default: 'NULL', Extra: '' }
remote_port: { Field: remote_port, Type: varchar(128), 'Null': false, Default: 'NULL', Extra: '' }
remote_port_id: { Field: remote_port_id, Type: int(11), 'Null': true, Default: 'NULL', Extra: '' }
remote_version: { Field: remote_version, Type: varchar(256), 'Null': false, Default: 'NULL', Extra: '' }

1
sql-schema/210.sql Normal file
View File

@@ -0,0 +1 @@
ALTER TABLE `links` MODIFY `remote_platform` VARCHAR(256);