LibreNMS/includes/polling/ports.inc.php

969 lines
40 KiB
PHP

<?php
// Build SNMP Cache Array
use Illuminate\Support\Str;
use LibreNMS\Config;
use LibreNMS\Enum\PortAssociationMode;
use LibreNMS\RRD\RrdDefinition;
use LibreNMS\Util\Debug;
use LibreNMS\Util\Number;
$data_oids = [
'ifName',
'ifDescr',
'ifAlias',
'ifAdminStatus',
'ifOperStatus',
'ifMtu',
'ifSpeed',
'ifType',
'ifPhysAddress',
'ifPromiscuousMode',
'ifConnectorPresent',
'ifDuplex',
'ifTrunk',
'ifVlan',
];
$stat_oids = [
'ifInErrors',
'ifOutErrors',
'ifInUcastPkts',
'ifOutUcastPkts',
'ifInNUcastPkts',
'ifOutNUcastPkts',
'ifHCInMulticastPkts',
'ifHCInBroadcastPkts',
'ifHCOutMulticastPkts',
'ifHCOutBroadcastPkts',
'ifInOctets',
'ifOutOctets',
'ifHCInOctets',
'ifHCOutOctets',
'ifInDiscards',
'ifOutDiscards',
'ifInUnknownProtos',
'ifInBroadcastPkts',
'ifOutBroadcastPkts',
'ifInMulticastPkts',
'ifOutMulticastPkts',
];
$stat_oids_db = [
'ifInOctets',
'ifOutOctets',
'ifInErrors',
'ifOutErrors',
'ifInUcastPkts',
'ifOutUcastPkts',
];
$stat_oids_db_extended = [
'ifInNUcastPkts',
'ifOutNUcastPkts',
'ifInDiscards',
'ifOutDiscards',
'ifInUnknownProtos',
'ifInBroadcastPkts',
'ifOutBroadcastPkts',
'ifInMulticastPkts',
'ifOutMulticastPkts',
];
$cisco_oids = [
'locIfHardType',
'locIfInRunts',
'locIfInGiants',
'locIfInCRC',
'locIfInFrame',
'locIfInOverrun',
'locIfInIgnored',
'locIfInAbort',
'locIfCollisions',
'locIfInputQueueDrops',
'locIfOutputQueueDrops',
];
/*
* CISCO-IF-EXTENSION MIB
*/
$cisco_if_extension_oids = [
'cieIfInRuntsErrs',
'cieIfInGiantsErrs',
'cieIfInFramingErrs',
'cieIfInOverrunErrs',
'cieIfInIgnored',
'cieIfInAbortErrs',
'cieIfInputQueueDrops',
'cieIfOutputQueueDrops',
];
$pagp_oids = [
'pagpOperationMode',
];
$pagp_extended_oids = [
'pagpPortState',
'pagpPartnerDeviceId',
'pagpPartnerLearnMethod',
'pagpPartnerIfIndex',
'pagpPartnerGroupIfIndex',
'pagpPartnerDeviceName',
'pagpEthcOperationMode',
'pagpDeviceId',
'pagpGroupIfIndex',
];
$ifmib_oids = [
'ifDescr',
'ifAdminStatus',
'ifOperStatus',
'ifLastChange',
'ifType',
'ifPhysAddress',
'ifMtu',
'ifInErrors',
'ifOutErrors',
'ifInDiscards',
'ifOutDiscards',
];
$table_base_oids = [
'ifName',
'ifAlias',
'ifDescr',
'ifHighSpeed',
'ifOperStatus',
'ifAdminStatus',
];
$hc_mappings = [
'ifHCInOctets' => 'ifInOctets',
'ifHCOutOctets' => 'ifOutOctets',
'ifHCInUcastPkts' => 'ifInUcastPkts',
'ifHCOutUcastPkts' => 'ifOutUcastPkts',
'ifHCInBroadcastPkts' => 'ifInBroadcastPkts',
'ifHCOutBroadcastPkts' => 'ifOutBroadcastPkts',
'ifHCInMulticastPkts' => 'ifInMulticastPkts',
'ifHCOutMulticastPkts' => 'ifOutMulticastPkts',
];
$hc_oids = [
'ifInMulticastPkts',
'ifInBroadcastPkts',
'ifOutMulticastPkts',
'ifOutBroadcastPkts',
'ifHCInOctets',
'ifHCInUcastPkts',
'ifHCInMulticastPkts',
'ifHCInBroadcastPkts',
'ifHCOutOctets',
'ifHCOutUcastPkts',
'ifHCOutMulticastPkts',
'ifHCOutBroadcastPkts',
'ifPromiscuousMode',
'ifConnectorPresent',
];
$nonhc_oids = [
'ifSpeed',
'ifInOctets',
'ifInUcastPkts',
'ifInUnknownProtos',
'ifOutOctets',
'ifOutUcastPkts',
];
$shared_oids = [
'ifInErrors',
'ifOutErrors',
'ifInNUcastPkts',
'ifOutNUcastPkts',
'ifInDiscards',
'ifOutDiscards',
'ifPhysAddress',
'ifLastChange',
'ifType',
'ifMtu',
];
$dot3_oids = [
'dot3StatsIndex',
'dot3StatsDuplexStatus',
];
// Query known ports and mapping table in order of discovery to make sure
// the latest discoverd/polled port is in the mapping tables.
$ports_mapped = get_ports_mapped($device['device_id'], true);
$ports = $ports_mapped['ports'];
//
// Rename any old RRD files still named after the previous ifIndex based naming schema.
foreach ($ports_mapped['maps']['ifIndex'] as $ifIndex => $port_id) {
foreach (['', '-adsl', '-dot3'] as $suffix) {
$old_rrd_name = "port-$ifIndex$suffix";
$new_rrd_name = \Rrd::portName($port_id, ltrim($suffix, '-'));
\Rrd::renameFile($device, $old_rrd_name, $new_rrd_name);
}
}
echo 'Caching Oids: ';
$port_stats = [];
if ($device['os'] === 'f5' && (version_compare($device['version'], '11.2.0', '>=') && version_compare($device['version'], '11.7', '<'))) {
require 'ports/f5.inc.php';
} elseif ($device['os'] === 'exalink-fusion') {
require 'ports/exalink-fusion.inc.php';
} else {
if (Config::getOsSetting($device['os'], 'polling.selected_ports') || (isset($device['attribs']['selected_ports']) && $device['attribs']['selected_ports'] == 'true')) {
echo 'Selected ports polling ';
// remove the deleted and disabled ports and mark them skipped
$polled_ports = array_filter($ports, function ($port) use ($ports) {
$ports[$port['ifIndex']]['skipped'] = true;
return ! ($port['deleted'] || $port['disabled']);
});
// only try to guess if we should walk base oids if selected_ports is set only globally
$walk_base = false;
if (! Config::has("os.{$device['os']}.polling.selected_ports") && ! array_key_exists('selected_ports', $device['attribs'])) {
// if less than 5 ports or less than 10% of the total ports are skipped, walk the base oids instead of get
$polled_port_count = count($polled_ports);
$total_port_count = count($ports);
$walk_base = $total_port_count - $polled_port_count < 5 || $polled_port_count / $total_port_count > 0.9;
if ($walk_base) {
echo "Not enough ports for selected port polling, walking base OIDs instead\n";
foreach ($table_base_oids as $oid) {
$port_stats = snmpwalk_cache_oid($device, $oid, $port_stats, 'IF-MIB');
}
}
}
foreach ($polled_ports as $port_id => $port) {
$ifIndex = $port['ifIndex'];
$port_stats[$ifIndex]['ifType'] = $port['ifType']; // we keep it as it is not included in $base_oids
if (is_port_valid($port, $device)) {
if (! $walk_base) {
// we didn't walk,so snmpget the base oids
$base_oids = implode(".$ifIndex ", $table_base_oids) . ".$ifIndex";
$port_stats = snmp_get_multi($device, $base_oids, '-OQUst', 'IF-MIB', null, $port_stats);
}
// if admin down or operator down since the last poll, skip polling this port
$admin_down = $port['ifAdminStatus_prev'] === 'down' && $port_stats[$ifIndex]['ifAdminStatus'] === 'down';
$oper_down = $port['ifOperStatus_prev'] === 'down' && $port_stats[$ifIndex]['ifOperStatus'] === 'down';
$ll_down = $port['ifOperStatus_prev'] === 'lowerLayerDown' && $port_stats[$ifIndex]['ifOperStatus'] === 'lowerLayerDown';
if ($admin_down || $oper_down || $ll_down) {
if ($admin_down) {
d_echo(" port $ifIndex is still admin down\n");
} else {
d_echo(" port $ifIndex is still down\n");
}
$ports[$port_id]['skipped'] = true;
} else {
d_echo(" $ifIndex: valid\n");
if (is_numeric($port_stats[$ifIndex]['ifHighSpeed']) && $port_stats[$ifIndex]['ifHighSpeed'] > 0) {
$full_oids = array_merge($hc_oids, $shared_oids);
} else {
$full_oids = array_merge($nonhc_oids, $shared_oids);
}
$oids = implode(".$ifIndex ", $full_oids) . ".$ifIndex";
$extra_oids = implode(".$ifIndex ", $dot3_oids) . ".$ifIndex";
unset($full_oids);
$port_stats = snmp_get_multi($device, $oids, '-OQUst', 'IF-MIB', null, $port_stats);
$port_stats = snmp_get_multi($device, $extra_oids, '-OQUst', 'EtherLike-MIB', null, $port_stats);
if ($device['os'] != 'asa') {
$port_stats = snmp_get_multi($device, "dot1qPvid.$ifIndex", '-OQUst', 'Q-BRIDGE-MIB', null, $port_stats);
}
}
}
}
} else {
echo 'Full ports polling ';
// For devices that are on the bad_ifXentry list, try fetching ifAlias to have nice interface descriptions.
if (! in_array(strtolower($device['hardware']), array_map('strtolower', (array) Config::getOsSetting($device['os'], 'bad_ifXEntry', [])))) {
$port_stats = snmpwalk_cache_oid($device, 'ifXEntry', $port_stats, 'IF-MIB');
} else {
$port_stats = snmpwalk_cache_oid($device, 'ifAlias', $port_stats, 'IF-MIB', null, '-OQUst');
$port_stats = snmpwalk_cache_oid($device, 'ifName', $port_stats, 'IF-MIB', null, '-OQUst');
}
$hc_test = array_slice($port_stats, 0, 1);
// If the device doesn't have ifXentry data, fetch ifEntry instead.
if ((! isset($hc_test[0]['ifHCInOctets']) && ! is_numeric($hc_test[0]['ifHCInOctets'] ?? null)) ||
((! isset($hc_test[0]['ifHighSpeed']) && ! is_numeric($hc_test[0]['ifHighSpeed'])))) {
$ifEntrySnmpFlags = ['-OQUst'];
if ($device['os'] == 'bintec-beip-plus') {
$ifEntrySnmpFlags = ['-OQUst', '-Cc'];
}
$port_stats = snmpwalk_cache_oid($device, 'ifEntry', $port_stats, 'IF-MIB', null, $ifEntrySnmpFlags);
} else {
// For devices with ifXentry data, only specific ifEntry keys are fetched to reduce SNMP load
foreach ($ifmib_oids as $oid) {
echo "$oid ";
$port_stats = snmpwalk_cache_oid($device, $oid, $port_stats, 'IF-MIB', null, '-OQUst');
}
}
if ($device['os'] != 'asa') {
echo 'dot3StatsDuplexStatus';
if (Config::get('enable_ports_poe') || Config::get('enable_ports_etherlike')) {
$port_stats = snmpwalk_cache_oid($device, 'dot3StatsIndex', $port_stats, 'EtherLike-MIB');
}
$dot3StatsDuplexStatusSnmpFlags = '-OQUs';
if ($device['os'] == 'bintec-beip-plus') {
$dot3StatsDuplexStatusSnmpFlags = '-Cc';
}
$port_stats = snmpwalk_cache_oid($device, 'dot3StatsDuplexStatus', $port_stats, 'EtherLike-MIB', null, $dot3StatsDuplexStatusSnmpFlags);
$port_stats = snmpwalk_cache_oid($device, 'dot1qPvid', $port_stats, 'Q-BRIDGE-MIB');
}
}
}
$os_file = base_path("includes/polling/ports/os/{$device['os']}.inc.php");
if (file_exists($os_file)) {
require $os_file;
}
if (Config::get('enable_ports_adsl')) {
$device['xdsl_count'] = dbFetchCell("SELECT COUNT(*) FROM `ports` WHERE `device_id` = ? AND `ifType` in ('adsl','vdsl','vdsl2')", [$device['device_id']]);
}
if ($device['xdsl_count'] > '0') {
echo 'ADSL ';
$port_stats = snmpwalk_cache_oid($device, '.1.3.6.1.2.1.10.94.1', $port_stats, 'ADSL-LINE-MIB');
}//end if
if (Config::get('enable_ports_poe')) {
// Code by OS device
if ($device['os'] == 'ios' || $device['os'] == 'iosxe') {
echo 'cpeExtPsePortEntry';
$port_stats_poe = snmpwalk_cache_oid($device, 'cpeExtPsePortEntry', [], 'CISCO-POWER-ETHERNET-EXT-MIB');
$port_ent_to_if = snmpwalk_cache_oid($device, 'portIfIndex', [], 'CISCO-STACK-MIB');
if (! $port_ent_to_if) {
$ifTable_ifDescr = snmpwalk_cache_oid($device, 'ifDescr', [], 'IF-MIB');
$port_ent_to_if = [];
foreach ($ifTable_ifDescr as $if_index => $if_descr) {
/*
The ...EthernetX/Y/Z SNMP entries on Catalyst 9x00 iosxe
are cpeExtStuff.X.Z instead of cpeExtStuff.X.Y.Z
We need to ignore the middle subslot number so this is slot.port
*/
if (preg_match('/^[a-z]+ethernet(\d+)\/(\d+)(?:\/(\d+))?$/i', $if_descr['ifDescr'], $matches)) {
$port_ent_to_if[$matches[1] . '.' . ($matches[3] ?: $matches[2])] = ['portIfIndex' => $if_index];
}
}
}
foreach ($port_stats_poe as $p_index => $p_stats) {
//We replace the ENTITY EntIndex by the IfIndex using the portIfIndex table (stored in $port_ent_to_if).
//Result is merged into $port_stats
if ($port_ent_to_if[$p_index] && $port_ent_to_if[$p_index]['portIfIndex'] && $port_stats[$port_ent_to_if[$p_index]['portIfIndex']]) {
$port_stats[$port_ent_to_if[$p_index]['portIfIndex']] = $port_stats[$port_ent_to_if[$p_index]['portIfIndex']] + $p_stats;
}
}
} elseif ($device['os'] == 'vrp') {
echo 'HwPoePortEntry';
$vrp_poe_oids = [
'hwPoePortReferencePower',
'hwPoePortMaximumPower',
'hwPoePortConsumingPower',
'hwPoePortPeakPower',
'hwPoePortEnable',
];
foreach ($vrp_poe_oids as $oid) {
$port_stats = snmpwalk_cache_oid($device, $oid, $port_stats, 'HUAWEI-POE-MIB');
}
} elseif ($device['os'] == 'linksys-ss') {
echo 'rlPethPsePort';
$linksys_poe_oids = [
'pethPsePortAdminEnable',
'rlPethPsePortPowerLimit',
'rlPethPsePortOutputPower',
];
foreach ($linksys_poe_oids as $oid) {
$port_stats_temp = snmpwalk_cache_oid($device, $oid, $port_stats_temp, 'LINKSYS-POE-MIB:POWER-ETHERNET-MIB');
}
foreach ($port_stats_temp as $key => $value) {
//remove the group index and only keep the ifIndex
[$group_id, $if_id] = explode('.', $key);
$port_stats[$if_id] = array_merge($port_stats[$if_id], $value);
}
} elseif ($device['os'] == 'jetstream') {
echo 'tpPoePortConfigEntry';
$port_stats_poe = snmpwalk_cache_oid($device, 'tpPoePortConfigEntry', [], 'TPLINK-POWER-OVER-ETHERNET-MIB');
$ifTable_ifDescr = snmpwalk_cache_oid($device, 'ifDescr', [], 'IF-MIB');
$port_ent_to_if = [];
foreach ($ifTable_ifDescr as $if_index => $if_descr) {
if (preg_match('/^[a-z]+ethernet \d+\/\d+\/(\d+)$/i', $if_descr['ifDescr'], $matches)) {
$port_ent_to_if[$matches[1]] = $if_index;
}
}
foreach ($port_stats_poe as $p_index => $p_stats) {
$if_id = $port_ent_to_if[$p_index];
$port_stats[$if_id] = array_merge($port_stats[$if_id], $p_stats);
}
}
}
if (isset($device['os_group']) && $device['os_group'] == 'cisco' && $device['os'] != 'asa') {
foreach ($pagp_oids as $oid) {
$pagp_port_stats = snmpwalk_cache_oid($device, $oid, [], 'CISCO-PAGP-MIB');
}
if (count($pagp_port_stats) > 0) {
foreach ($pagp_port_stats as $p_index => $p_stats) {
$port_stats[$p_index]['pagpOperationMode'] = $p_stats['pagpOperationMode'];
}
foreach ($pagp_extended_oids as $oid) {
$port_stats = snmpwalk_cache_oid($device, $oid, $port_stats, 'CISCO-PAGP-MIB');
}
}
// Grab data to put ports into vlans or make them trunks
// FIXME we probably shouldn't be doing this from the VTP MIB, right?
$port_stats = snmpwalk_cache_oid($device, 'vmVlan', $port_stats, 'CISCO-VLAN-MEMBERSHIP-MIB');
$port_stats = snmpwalk_cache_oid($device, 'vlanTrunkPortEncapsulationOperType', $port_stats, 'CISCO-VTP-MIB');
$port_stats = snmpwalk_cache_oid($device, 'vlanTrunkPortNativeVlan', $port_stats, 'CISCO-VTP-MIB');
}//end if
/*
* Most (all) of the IOS/IOS-XE devices support CISCO-IF-EXTENSION MIB that provides
* additional informationa bout input and output errors as seen in `show interface` output.
*/
if ($device['os'] == 'ios' || $device['os'] == 'iosxe') {
foreach ($cisco_if_extension_oids as $oid) {
$port_stats = snmpwalk_cache_oid($device, $oid, $port_stats, 'CISCO-IF-EXTENSION-MIB');
}
}
$polled = time();
// End Building SNMP Cache Array
d_echo($port_stats);
// By default libreNMS uses the ifIndex to associate ports on devices with ports discoverd/polled
// before and stored in the database. On Linux boxes this is a problem as ifIndexes may be
// unstable between reboots or (re)configuration of tunnel interfaces (think: GRE/OpenVPN/Tinc/...)
// The port association configuration allows to choose between association via ifIndex, ifName,
// or maybe other means in the future. The default port association mode still is ifIndex for
// compatibility reasons.
$port_association_mode = Config::get('default_port_association_mode');
if ($device['port_association_mode']) {
$port_association_mode = PortAssociationMode::getName($device['port_association_mode']);
}
$ports_found = [];
// New interface detection
foreach ($port_stats as $ifIndex => $port) {
// Store ifIndex in port entry and prefetch ifName as we'll need it multiple times
$port['ifIndex'] = $ifIndex;
$ifName = $port['ifName'];
// Get port_id according to port_association_mode used for this device
$port_id = get_port_id($ports_mapped, $port, $port_association_mode);
if (is_port_valid($port, $device)) {
d_echo(' valid');
// Port newly discovered?
if (! $port_id || empty($ports[$port_id])) {
/**
* When using the ifName or ifDescr as means to map discovered ports to
* known ports in the DB (think of port association mode) it's possible
* that we're facing the problem that the ifName or ifDescr polled from
* the device is unset or an empty string (like when querying some ubnt
* devices...). If this happends we have no way to map this port to any
* port found in the database. As reported this situation may occur for
* the time of one poll and might resolve automagically before the next
* poller run happens. Without this special case this would lead to new
* ports added to the database each time this situation occurs. To give
* the user the choice between »a lot of new ports« and »some poll runs
* are missed but ports stay stable« the 'ignore_unmapable_port' option
* has been added to configure this behaviour. To skip the port in this
* loop is sufficient as the next loop is looping only over ports found
* in the database and "maps back". As we did not add a new port to the
* DB here, there's no port to be mapped to.
*
* I'm using the in_array() check here, as I'm not sure if an "ifIndex"
* can be legally set to 0, which would yield True when checking if the
* value is empty().
*/
if (Config::get('ignore_unmapable_port') === true && in_array($port[$port_association_mode], ['', null])) {
continue;
}
$port_id = dbInsert(['device_id' => $device['device_id'], 'ifIndex' => $ifIndex, 'ifName' => $ifName], 'ports');
dbInsert(['port_id' => $port_id], 'ports_statistics');
$ports[$port_id] = dbFetchRow('SELECT * FROM `ports` WHERE `port_id` = ?', [$port_id]);
echo 'Adding: ' . $ifName . '(' . $ifIndex . ')(' . $port_id . ')';
} elseif ($ports[$port_id]['deleted'] == 1) {
// Port re-discovered after previous deletion?
dbUpdate(['deleted' => '0'], 'ports', '`port_id` = ?', [$port_id]);
$ports[$port_id]['deleted'] = '0';
}
if ($ports[$port_id]['ports_statistics_port_id'] === null) {
// in case the port was created before we created the table
dbInsert(['port_id' => $port_id], 'ports_statistics');
}
/** Assure stable bidirectional port mapping between DB and polled data
*
* Store the *current* ifIndex in the port info array containing all port information
* fetched from the database, as this is the only means we have to map ports_stats we
* just polled from the device to a port in $ports. All code below an includeed below
* will and has to map a port using it's ifIndex.
*/
$ports[$port_id]['ifIndex'] = $ifIndex;
$port_stats[$ifIndex]['port_id'] = $port_id;
/* Build a list of all ports, identified by their port_id, found within this poller run. */
$ports_found[] = $port_id;
} elseif (empty($ports[$port_id]['skipped'])) {
// Port vanished (mark as deleted) (except when skipped by selective port polling)
if ($ports[$port_id]['deleted'] != '1') {
dbUpdate(['deleted' => '1'], 'ports', '`port_id` = ?', [$port_id]);
$ports[$port_id]['deleted'] = '1';
}
}
} // End new interface detection
echo "\n";
// get last poll time to optimize poll_time, poll_prev and poll_period in table db
$prev_poll_times = array_filter(array_column($ports, 'poll_time'));
$max_poll_time_prev = empty($prev_poll_times) ? null : max($prev_poll_times);
$device_global_ports = [
'poll_time' => $polled,
'poll_prev' => $max_poll_time_prev,
'poll_period' => $max_poll_time_prev ? null : ($polled - $max_poll_time_prev),
];
$globally_updated_port_ids = [];
// Loop ports in the DB and update where necessary
foreach ($ports as $port) {
$port_id = $port['port_id'];
$ifIndex = $port['ifIndex'];
$port_info_string = 'Port ' . $port['ifName'] . ': ' . $port['ifDescr'] . " ($ifIndex / #$port_id) ";
/* We don't care for disabled ports, go on */
if ($port['disabled'] == 1) {
echo "{$port_info_string}disabled.\n";
continue;
}
/**
* If this port did not show up in $port_stats before it has been deleted
* since the last poller run. Mark it deleted in the database and go on.
*/
if (! in_array($port_id, $ports_found)) {
if ($port['deleted'] != '1') {
dbUpdate(['deleted' => '1'], 'ports', '`device_id` = ? AND `port_id` = ?', [$device['device_id'], $port_id]);
echo "{$port_info_string}deleted.\n";
}
continue;
}
echo $port_info_string;
if ($port_stats[$ifIndex]) {
// Check to make sure Port data is cached.
$this_port = &$port_stats[$ifIndex];
if (Str::startsWith($device['os'], 'vmware') && preg_match('/Device ([a-z0-9]+) at .*/', $this_port['ifDescr'], $matches)) {
$this_port['ifDescr'] = $matches[1];
}
$polled_period = ($polled - $port['poll_time']);
$port['update'] = [];
$port['update_extended'] = [];
$port['state'] = [];
if ($port_association_mode != 'ifIndex') {
$port['update']['ifIndex'] = $ifIndex;
}
// rewrite the ifPhysAddress
if (strpos($this_port['ifPhysAddress'] ?? '', ':')) {
[$a_a, $a_b, $a_c, $a_d, $a_e, $a_f] = explode(':', $this_port['ifPhysAddress']);
$this_port['ifPhysAddress'] = zeropad($a_a) . zeropad($a_b) . zeropad($a_c) . zeropad($a_d) . zeropad($a_e) . zeropad($a_f);
}
// use HC values if they are available
foreach ($hc_mappings as $hc_oid => $if_oid) {
if (isset($this_port[$hc_oid]) && $this_port[$hc_oid]) {
d_echo("$hc_oid ");
$this_port[$if_oid] = $this_port[$hc_oid];
} else {
d_echo("$if_oid ");
}
}
// ifHighSpeed is signed integer, but should be unsigned (Gauge32 in RFC2233). Workaround for some fortinet devices.
if ($device['os'] == 'fortigate' || $device['os'] == 'fortisandbox') {
if ($this_port['ifHighSpeed'] > 2147483647) {
$this_port['ifHighSpeed'] = null;
}
}
if (isset($this_port['ifHighSpeed']) && is_numeric($this_port['ifHighSpeed'])) {
d_echo("ifHighSpeed ({$this_port['ifHighSpeed']}) ");
$this_port['ifSpeed'] = $this_port['ifHighSpeed'] . '000000'; // * 1000000, but handle in sql
} elseif (isset($this_port['ifSpeed']) && is_numeric($this_port['ifSpeed'])) {
d_echo("ifSpeed ({$this_port['ifSpeed']}) ");
} else {
d_echo('No ifSpeed ');
$this_port['ifSpeed'] = 0;
}
// Overwrite ifDuplex with dot3StatsDuplexStatus if it exists
if (isset($this_port['dot3StatsDuplexStatus'])) {
echo 'dot3Duplex ';
$this_port['ifDuplex'] = $this_port['dot3StatsDuplexStatus'];
}
// update ifLastChange. only in the db, not rrd
if (isset($this_port['ifLastChange']) && is_numeric($this_port['ifLastChange'])) {
if ((int) $this_port['ifLastChange'] != (int) $port['ifLastChange']) {
$port['update']['ifLastChange'] = $this_port['ifLastChange'];
}
} elseif ($port['ifLastChange'] != 0) {
$port['update']['ifLastChange'] = 0; // no data, so use the same as device uptime
}
// Set VLAN and Trunk from Cisco
if (isset($this_port['vlanTrunkPortEncapsulationOperType']) && $this_port['vlanTrunkPortEncapsulationOperType'] != 'notApplicable') {
$this_port['ifTrunk'] = $this_port['vlanTrunkPortEncapsulationOperType'];
if (isset($this_port['vlanTrunkPortNativeVlan'])) {
$this_port['ifVlan'] = $this_port['vlanTrunkPortNativeVlan'];
}
}
if (isset($this_port['vmVlan'])) {
$this_port['ifVlan'] = $this_port['vmVlan'];
}
// Set VLAN and Trunk from Q-BRIDGE-MIB
if (! isset($this_port['ifVlan']) && isset($this_port['dot1qPvid'])) {
$this_port['ifVlan'] = $this_port['dot1qPvid'];
}
// Set ifConnectorPresent to null when the device does not support IF-MIB truth values.
if (isset($this_port['ifConnectorPresent']) && ! in_array($this_port['ifConnectorPresent'], ['true', 'false'])) {
$this_port['ifConnectorPresent'] = null;
}
// FIXME use $q_bridge_mib[$this_port['ifIndex']] to see if it is a trunk (>1 array count)
echo 'VLAN = ' . ($this_port['ifVlan'] ?? '?') . ' ';
// attempt to fill missing fields
port_fill_missing($this_port, $device);
// Update IF-MIB data
$tune_port = false;
foreach ($data_oids as $oid) {
if ($oid == 'ifAlias') {
if (! empty($device['attribs']['ifName:' . $port['ifName']])) {
$this_port['ifAlias'] = $port['ifAlias'];
} else {
$this_port['ifAlias'] = \LibreNMS\Util\StringHelpers::inferEncoding($this_port['ifAlias']);
}
}
if ($oid == 'ifSpeed') {
if (! empty($device['attribs']['ifSpeed:' . $port['ifName']])) {
$this_port['ifSpeed'] = $port['ifSpeed'];
}
}
if ($port[$oid] != $this_port[$oid] && ! isset($this_port[$oid])) {
$port['update'][$oid] = ['NULL'];
log_event($oid . ': ' . $port[$oid] . ' -> NULL', $device, 'interface', 4, $port['port_id']);
d_echo($oid . ': ' . $port[$oid] . ' -> NULL ', $oid . ' ');
} elseif ($port[$oid] != ($this_port[$oid] ?? null)) {
// if the value is different, update it
// rrdtune if needed
$port_tune = $device['attribs']['ifName_tune:' . $port['ifName']];
$device_tune = $device['attribs']['override_rrdtool_tune'];
if ($port_tune == 'true' ||
($device_tune == 'true' && $port_tune != 'false') ||
(Config::get('rrdtool_tune') == 'true' && $port_tune != 'false' && $device_tune != 'false')) {
if ($oid == 'ifSpeed') {
$tune_port = true;
}
}
// set the update data
$port['update'][$oid] = $this_port[$oid];
// store the previous values for alerting
if (in_array($oid, ['ifOperStatus', 'ifAdminStatus', 'ifSpeed'])) {
$port['update'][$oid . '_prev'] = $port[$oid];
}
if ($oid == 'ifSpeed') {
$old = Number::formatSi($port[$oid], 2, 3, 'bps');
$new = Number::formatSi($this_port[$oid], 2, 3, 'bps');
} else {
$old = $port[$oid];
$new = $this_port[$oid];
}
log_event($oid . ': ' . $old . ' -> ' . $new, $device, 'interface', 3, $port['port_id']);
if (Debug::isEnabled()) {
d_echo($oid . ': ' . $old . ' -> ' . $new . ' ');
} else {
echo $oid . ' ';
}
} else {
if (in_array($oid, ['ifOperStatus', 'ifAdminStatus', 'ifSpeed'])) {
if ($port[$oid . '_prev'] == null) {
$port['update'][$oid . '_prev'] = $this_port[$oid];
}
}
}
}//end foreach
// Parse description (usually ifAlias) if config option set
if (Config::has('port_descr_parser') && is_file(Config::get('install_dir') . '/' . Config::get('port_descr_parser'))) {
$port_attribs = [
'type',
'descr',
'circuit',
'speed',
'notes',
];
$port_ifAlias = []; // for port descr parser mappings
include Config::get('install_dir') . '/' . Config::get('port_descr_parser');
foreach ($port_attribs as $attrib) {
$attrib_key = 'port_descr_' . $attrib;
if (($port_ifAlias[$attrib] ?? null) != $port[$attrib_key]) {
if (! isset($port_ifAlias[$attrib])) {
$port_ifAlias[$attrib] = ['NULL'];
$log_port = 'NULL';
} else {
$log_port = $port_ifAlias[$attrib];
}
$port['update'][$attrib_key] = $port_ifAlias[$attrib];
log_event($attrib . ': ' . $port[$attrib_key] . ' -> ' . $log_port, $device, 'interface', 3, $port['port_id']);
unset($log_port);
}
}
}//end if
if (! empty($port['skipped'])) {
// We don't care about statistics for skipped selective polling ports
d_echo("$port_id skipped because selective polling ports is set.");
} elseif ($port['ifType'] != 'vdsl' && $port['ifType'] != 'adsl' && $port['ifOperStatus'] == 'down' && $port['ifOperStatus_prev'] == 'down' && $this_port['ifOperStatus'] == 'down' && ($this_port['ifLastChange'] ?? null) == $port['ifLastChange']) {
// We don't care about statistics for down ports on which states did not change since last polling
// We still take into account 'adsl' & 'vdsl' ports that may update speed/noise even if the interface is status down
d_echo("$port_id skipped because port is still down since last polling.");
} else {
// End parse ifAlias
// Update IF-MIB metrics
$_stat_oids = array_merge($stat_oids_db, $stat_oids_db_extended);
foreach ($_stat_oids as $oid) {
$port_update = 'update';
$extended_metric = ! in_array($oid, $stat_oids_db, true);
if ($extended_metric) {
$port_update = 'update_extended';
}
$port[$port_update][$oid] = set_numeric($this_port[$oid] ?? 0);
$port[$port_update][$oid . '_prev'] = set_numeric($port[$oid]);
$oid_prev = $oid . '_prev';
if (isset($port[$oid])) {
$oid_diff = (($this_port[$oid] ?? 0) - $port[$oid]);
$oid_rate = ($oid_diff / $polled_period);
if ($oid_rate < 0) {
$oid_rate = '0';
$oid_diff = '0';
echo "negative $oid";
}
$port['stats'][$oid . '_rate'] = $oid_rate;
$port['stats'][$oid . '_diff'] = $oid_diff;
$port[$port_update][$oid . '_rate'] = $oid_rate;
$port[$port_update][$oid . '_delta'] = $oid_diff;
d_echo("\n $oid ($oid_diff B) $oid_rate Bps $polled_period secs\n");
}//end if
}//end foreach
if (Config::get('debug_port.' . $port['port_id'])) {
$port_debug = $port['port_id'] . '|' . $polled . '|' . $polled_period . '|' . $this_port['ifHCInOctets'] . '|' . $this_port['ifHCOutOctets'];
$port_debug .= '|' . $port['stats']['ifInOctets_rate'] . '|' . $port['stats']['ifOutOctets_rate'] . "\n";
file_put_contents('/tmp/port_debug.txt', $port_debug, FILE_APPEND);
echo 'Wrote port debugging data';
}
$port['stats']['ifInBits_rate'] = round(($port['stats']['ifInOctets_rate'] * 8));
$port['stats']['ifOutBits_rate'] = round(($port['stats']['ifOutOctets_rate'] * 8));
// If we have a valid ifSpeed we should populate the stats for checking
if (is_numeric($this_port['ifSpeed']) && $this_port['ifSpeed'] > 0) {
$port['stats']['ifInBits_perc'] = Number::calculatePercent($port['stats']['ifInBits_rate'], $this_port['ifSpeed'], 0);
$port['stats']['ifOutBits_perc'] = Number::calculatePercent($port['stats']['ifOutBits_rate'], $this_port['ifSpeed'], 0);
}
echo 'bps(' . Number::formatSi($port['stats']['ifInBits_rate'], 2, 3, 'bps') . '/' . Number::formatSi($port['stats']['ifOutBits_rate'], 2, 3, 'bps') . ')';
echo 'bytes(' . Number::formatBi($port['stats']['ifInOctets_diff']) . '/' . Number::formatBi($port['stats']['ifOutOctets_diff']) . ')';
echo 'pkts(' . Number::formatSi($port['stats']['ifInUcastPkts_rate'], 2, 3, 'pps') . '/' . Number::formatSi($port['stats']['ifOutUcastPkts_rate'], 2, 3, 'pps') . ')';
// Update data stores
$rrd_name = Rrd::portName($port_id, '');
$rrdfile = Rrd::name($device['hostname'], $rrd_name);
$rrd_def = RrdDefinition::make()
->addDataset('INOCTETS', 'DERIVE', 0, 12500000000)
->addDataset('OUTOCTETS', 'DERIVE', 0, 12500000000)
->addDataset('INERRORS', 'DERIVE', 0, 12500000000)
->addDataset('OUTERRORS', 'DERIVE', 0, 12500000000)
->addDataset('INUCASTPKTS', 'DERIVE', 0, 12500000000)
->addDataset('OUTUCASTPKTS', 'DERIVE', 0, 12500000000)
->addDataset('INNUCASTPKTS', 'DERIVE', 0, 12500000000)
->addDataset('OUTNUCASTPKTS', 'DERIVE', 0, 12500000000)
->addDataset('INDISCARDS', 'DERIVE', 0, 12500000000)
->addDataset('OUTDISCARDS', 'DERIVE', 0, 12500000000)
->addDataset('INUNKNOWNPROTOS', 'DERIVE', 0, 12500000000)
->addDataset('INBROADCASTPKTS', 'DERIVE', 0, 12500000000)
->addDataset('OUTBROADCASTPKTS', 'DERIVE', 0, 12500000000)
->addDataset('INMULTICASTPKTS', 'DERIVE', 0, 12500000000)
->addDataset('OUTMULTICASTPKTS', 'DERIVE', 0, 12500000000);
$fields = [
'INOCTETS' => $this_port['ifInOctets'] ?? null,
'OUTOCTETS' => $this_port['ifOutOctets'] ?? null,
'INERRORS' => $this_port['ifInErrors'],
'OUTERRORS' => $this_port['ifOutErrors'],
'INUCASTPKTS' => $this_port['ifInUcastPkts'] ?? null,
'OUTUCASTPKTS' => $this_port['ifOutUcastPkts'] ?? null,
'INNUCASTPKTS' => $this_port['ifInNUcastPkts'] ?? null,
'OUTNUCASTPKTS' => $this_port['ifOutNUcastPkts'] ?? null,
'INDISCARDS' => $this_port['ifInDiscards'],
'OUTDISCARDS' => $this_port['ifOutDiscards'],
'INUNKNOWNPROTOS' => $this_port['ifInUnknownProtos'] ?? null,
'INBROADCASTPKTS' => $this_port['ifInBroadcastPkts'],
'OUTBROADCASTPKTS' => $this_port['ifOutBroadcastPkts'],
'INMULTICASTPKTS' => $this_port['ifInMulticastPkts'],
'OUTMULTICASTPKTS' => $this_port['ifOutMulticastPkts'],
];
// non rrd stats (will be filtered)
$fields['ifInUcastPkts_rate'] = $port['ifInUcastPkts_rate'];
$fields['ifOutUcastPkts_rate'] = $port['ifOutUcastPkts_rate'];
$fields['ifInErrors_rate'] = $port['ifInErrors_rate'];
$fields['ifOutErrors_rate'] = $port['ifOutErrors_rate'];
$fields['ifInOctets_rate'] = $port['ifInOctets_rate'];
$fields['ifOutOctets_rate'] = $port['ifOutOctets_rate'];
// Add delta rate between current poll and last poll.
$fields['ifInBits_rate'] = $port['stats']['ifInBits_rate'];
$fields['ifOutBits_rate'] = $port['stats']['ifOutBits_rate'];
if ($tune_port === true) {
Rrd::tune('port', $rrdfile, $this_port['ifSpeed']);
}
$tags = [
'ifName' => $port['ifName'],
'ifAlias' => $port['ifAlias'],
'ifIndex' => $port['ifIndex'],
'port_descr_type' => $port['port_descr_type'],
'rrd_name' => $rrd_name,
'rrd_def' => $rrd_def,
];
app('Datastore')->put($device, 'ports', $tags, $fields);
// End Update IF-MIB
// Update PAgP
if (! empty($this_port['pagpOperationMode']) || ! empty($port['pagpOperationMode'])) {
foreach ($pagp_oids as $oid) {
// Loop the OIDs
if ($this_port[$oid] != $port[$oid]) {
// If data has changed, build a query
$port['update'][$oid] = $this_port[$oid];
echo 'PAgP ';
log_event("$oid -> " . $this_port[$oid], $device, 'interface', 3, $port['port_id']);
}
}
}
// End Update PAgP
// Do EtherLike-MIB
if (Config::get('enable_ports_etherlike')) {
include 'ports/port-etherlike.inc.php';
}
// Do ADSL MIB
if (Config::get('enable_ports_adsl')) {
include 'ports/port-adsl.inc.php';
}
// Do PoE MIBs
if (Config::get('enable_ports_poe')) {
include 'ports/port-poe.inc.php';
}
if ($device['os'] == 'ios' || $device['os'] == 'iosxe') {
include 'ports/cisco-if-extension.inc.php';
}
}
foreach ($port['update'] as $key => $val_check) {
if (! isset($val_check)) {
unset($port['update'][$key]);
}
}
// Update Database if $port['update'] is not empty
// or if previous poll time $port['poll_time'] is different from device globally previous port time $device_global_ports["poll_prev"]
// This could happen if disabled port was enabled since last polling
if (! empty($port['update']) || $device_global_ports['poll_prev'] != $port['poll_time']) {
$port['update']['poll_time'] = $polled;
$port['update']['poll_prev'] = $port['poll_time'];
$port['update']['poll_period'] = $polled_period;
$updated = dbUpdate($port['update'], 'ports', '`port_id` = ?', [$port_id]);
if (! empty($port['update_extended'])) {
$updated += dbUpdate($port['update_extended'], 'ports_statistics', '`port_id` = ?', [$port_id]);
}
d_echo("$updated updated");
} else {
$globally_updated_port_ids[] = $port_id;
}
// End Update Database
}
echo "\n";
// Clear Per-Port Variables Here
unset($this_port, $port);
} //end port update
// Update the poll_time, poll_prev and poll_period of all ports in an unique request
$updated = DB::table('ports')->whereIntegerInRaw('port_id', $globally_updated_port_ids)->update($device_global_ports);
d_echo("$updated updated\n");
// Clear Variables Here
unset($port_stats, $ports_found, $data_oids, $stat_oids, $stat_oids_db, $stat_oids_db_extended, $cisco_oids, $pagp_oids, $ifmib_oids, $hc_test, $ports_mapped, $ports, $_stat_oids, $rrd_def);