mirror of
https://github.com/librenms/librenms.git
synced 2024-10-07 16:52:45 +00:00
bb944b9a06
* Improve OcNOS port breakout detection Old code required a transceiver to exist in one of the breakout ports * Allow functionality without prots module running
272 lines
16 KiB
PHP
272 lines
16 KiB
PHP
<?php
|
|
|
|
namespace LibreNMS\OS;
|
|
|
|
use App\Models\EntPhysical;
|
|
use App\Models\Transceiver;
|
|
use Illuminate\Support\Collection;
|
|
use LibreNMS\Interfaces\Discovery\EntityPhysicalDiscovery;
|
|
use LibreNMS\Interfaces\Discovery\TransceiverDiscovery;
|
|
use LibreNMS\OS;
|
|
use SnmpQuery;
|
|
|
|
class Ocnos extends OS implements EntityPhysicalDiscovery, TransceiverDiscovery
|
|
{
|
|
private ?bool $portBreakoutEnabled = null;
|
|
private ?Collection $ifNamePortIdMap = null;
|
|
|
|
public function discoverEntityPhysical(): Collection
|
|
{
|
|
$inventory = new Collection;
|
|
|
|
$stacks = SnmpQuery::walk('IPI-CMM-CHASSIS-MIB::cmmStackUnitTable')->table(1);
|
|
SnmpQuery::walk('IPI-CMM-CHASSIS-MIB::cmmSysSwModuleTable')->table(1, $stacks); // software version
|
|
foreach ($stacks as $cmmStackUnitIndex => $stack) {
|
|
$inventory->push(new EntPhysical([
|
|
'entPhysicalIndex' => $cmmStackUnitIndex,
|
|
'entPhysicalDescr' => $this->describeChassis($stack),
|
|
'entPhysicalClass' => 'chassis',
|
|
'entPhysicalName' => $stack['IPI-CMM-CHASSIS-MIB::cmmStackUnitModelName'] ?? null,
|
|
'entPhysicalModelName' => $stack['IPI-CMM-CHASSIS-MIB::cmmStackUnitPartNum'] ?? null,
|
|
'entPhysicalSerialNum' => $stack['IPI-CMM-CHASSIS-MIB::cmmStackUnitSerialNumber'] ?? null,
|
|
'entPhysicalContainedIn' => 0,
|
|
'entPhysicalMfgName' => $stack['IPI-CMM-CHASSIS-MIB::cmmStackMfgName'] ?? null,
|
|
'entPhysicalParentRelPos' => $cmmStackUnitIndex,
|
|
'entPhysicalHardwareRev' => $stack['IPI-CMM-CHASSIS-MIB::cmmStackUnitSwitchChipRev'] ?? null,
|
|
'entPhysicalSoftwareRev' => $stack['IPI-CMM-CHASSIS-MIB::cmmSysSwRuntimeImgVersion'] ?? null,
|
|
'entPhysicalFirmwareRev' => $stack['IPI-CMM-CHASSIS-MIB::cmmStackOnieVersion'] ?? null,
|
|
'entPhysicalIsFRU' => 'false',
|
|
]));
|
|
}
|
|
|
|
$psus = SnmpQuery::enumStrings()->walk('IPI-CMM-CHASSIS-MIB::cmmPsuFruTable')->table(2);
|
|
foreach ($psus as $cmmStackUnitIndex => $chassisPsu) {
|
|
foreach ($chassisPsu as $cmmSysPSUIndex => $psu) {
|
|
$inventory->push(new EntPhysical([
|
|
'entPhysicalIndex' => $cmmStackUnitIndex * 1000 + $cmmSysPSUIndex,
|
|
'entPhysicalDescr' => (isset($psu['IPI-CMM-CHASSIS-MIB::cmmPsuType']) && $psu['IPI-CMM-CHASSIS-MIB::cmmPsuType'] != 'not-applicable') ? $psu['IPI-CMM-CHASSIS-MIB::cmmPsuType'] : null,
|
|
'entPhysicalClass' => 'powerSupply',
|
|
'entPhysicalName' => $psu['IPI-CMM-CHASSIS-MIB::cmmSysPowerSupplyType'] ?? null,
|
|
'entPhysicalModelName' => $psu['IPI-CMM-CHASSIS-MIB::cmmPsuPartNum'] ?? null,
|
|
'entPhysicalSerialNum' => $psu['IPI-CMM-CHASSIS-MIB::cmmPsuSerialNumber'] ?? null,
|
|
'entPhysicalContainedIn' => $cmmStackUnitIndex,
|
|
'entPhysicalMfgName' => $psu['IPI-CMM-CHASSIS-MIB::cmmPsuManufactureId'] ?? null,
|
|
'entPhysicalParentRelPos' => $cmmSysPSUIndex,
|
|
'entPhysicalHardwareRev' => $psu['IPI-CMM-CHASSIS-MIB::cmmPsuPartNumRev'] ?? null,
|
|
'entPhysicalIsFRU' => 'true',
|
|
]));
|
|
}
|
|
}
|
|
|
|
$fans = SnmpQuery::enumStrings()->walk('IPI-CMM-CHASSIS-MIB::cmmFanFruTable')->table(3);
|
|
foreach ($fans as $cmmStackUnitIndex => $chassisFans) {
|
|
foreach ($chassisFans as $cmmFanTrayNumber => $fan) {
|
|
$inventory->push(new EntPhysical([
|
|
'entPhysicalIndex' => $cmmStackUnitIndex * 1000 + 100 + $cmmFanTrayNumber,
|
|
'entPhysicalDescr' => isset($psu['IPI-CMM-CHASSIS-MIB::cmmFanNumOfFanPerTray']) ? "Fan Tray with {$psu['IPI-CMM-CHASSIS-MIB::cmmFanNumOfFanPerTray']} Fan(s)" : null,
|
|
'entPhysicalClass' => 'fan',
|
|
'entPhysicalName' => $psu['IPI-CMM-CHASSIS-MIB::cmmFanType'] ?? null,
|
|
'entPhysicalModelName' => $psu['IPI-CMM-CHASSIS-MIB::cmmFanPartNum'] ?? null,
|
|
'entPhysicalSerialNum' => $psu['IPI-CMM-CHASSIS-MIB::cmmFanSerialNumber'] ?? null,
|
|
'entPhysicalContainedIn' => $cmmStackUnitIndex,
|
|
'entPhysicalMfgName' => $psu['IPI-CMM-CHASSIS-MIB::cmmFanManufactureId'] ?? null,
|
|
'entPhysicalParentRelPos' => $cmmFanTrayNumber,
|
|
'entPhysicalHardwareRev' => $psu['IPI-CMM-CHASSIS-MIB::cmmFanPartNumRev'] ?? null,
|
|
'entPhysicalIsFRU' => 'true',
|
|
]));
|
|
}
|
|
}
|
|
|
|
$transceivers = SnmpQuery::enumStrings()->walk('IPI-CMM-CHASSIS-MIB::cmmTransEEPROMTable')->table(2);
|
|
|
|
// load port name to port_id map
|
|
if (! empty($transceivers)) {
|
|
$ifNameToIndex = array_flip(SnmpQuery::cache()->walk('IF-MIB::ifName')->pluck());
|
|
}
|
|
|
|
foreach ($transceivers as $cmmStackUnitIndex => $chassisTransceivers) {
|
|
foreach ($chassisTransceivers as $cmmTransIndex => $transceiver) {
|
|
$inventory->push(new EntPhysical([
|
|
'entPhysicalIndex' => $cmmStackUnitIndex * 10000 + $cmmTransIndex,
|
|
'entPhysicalDescr' => $this->describeTransceiver($transceiver),
|
|
'entPhysicalClass' => 'module',
|
|
'entPhysicalName' => $transceiver['IPI-CMM-CHASSIS-MIB::cmmTransVendorPartNumber'] ?? null,
|
|
'entPhysicalModelName' => $transceiver['IPI-CMM-CHASSIS-MIB::cmmTransVendorPartNumber'] ?? null,
|
|
'entPhysicalSerialNum' => $transceiver['IPI-CMM-CHASSIS-MIB::cmmTransVendorSerialNumber'] ?? null,
|
|
'entPhysicalContainedIn' => $cmmStackUnitIndex,
|
|
'entPhysicalMfgName' => $transceiver['IPI-CMM-CHASSIS-MIB::cmmTransVendorName'] ?? null,
|
|
'entPhysicalParentRelPos' => $cmmTransIndex,
|
|
'entPhysicalHardwareRev' => $transceiver['IPI-CMM-CHASSIS-MIB::cmmTransVendorRevision'] ?? null,
|
|
'entPhysicalIsFRU' => 'true',
|
|
'ifIndex' => $ifNameToIndex[$this->guessIfName($cmmTransIndex, $transceiver['IPI-CMM-CHASSIS-MIB::cmmTransType'] ?? 'missing')] ?? null,
|
|
]));
|
|
}
|
|
}
|
|
|
|
return $inventory;
|
|
}
|
|
|
|
private function describeChassis(array $stack): string
|
|
{
|
|
$description = $stack['IPI-CMM-CHASSIS-MIB::cmmStackUnitModelName'] ?? '';
|
|
|
|
$items = [
|
|
'IPI-CMM-CHASSIS-MIB::cmmStackUnitNum100GigEtherPorts' => '100G',
|
|
'IPI-CMM-CHASSIS-MIB::cmmStackUnitNum50GigEtherPorts' => '50G',
|
|
'IPI-CMM-CHASSIS-MIB::cmmStackUnitNum40GigEtherPorts' => '40G',
|
|
'IPI-CMM-CHASSIS-MIB::cmmStackUnitNum25GigEtherPorts' => '25G',
|
|
'IPI-CMM-CHASSIS-MIB::cmmStackUnitNum10GigEtherPorts' => '10G',
|
|
'IPI-CMM-CHASSIS-MIB::cmmStackUnitNumGigEtherPorts' => '1G',
|
|
'IPI-CMM-CHASSIS-MIB::cmmStackUnitNumFastEtherPorts' => '100M',
|
|
'IPI-CMM-CHASSIS-MIB::cmmStackUnitNumPluggableModules' => 'Pluggable',
|
|
'IPI-CMM-CHASSIS-MIB::cmmStackUnitNumPowerSupplies' => 'PSU',
|
|
'IPI-CMM-CHASSIS-MIB::cmmStackUnitNumFanControllers' => 'FCU',
|
|
'IPI-CMM-CHASSIS-MIB::cmmStackUnitNumFanTrays' => 'Fans',
|
|
];
|
|
|
|
foreach ($items as $oid => $label) {
|
|
$value = $stack[$oid] ?? -100001;
|
|
if ($value > 0) {
|
|
$description .= " $stack[$oid]x$label";
|
|
}
|
|
}
|
|
|
|
return $description;
|
|
}
|
|
|
|
private function describeTransceiver(array $transceiver): string
|
|
{
|
|
$description = $transceiver['IPI-CMM-CHASSIS-MIB::cmmTransType'] ?? '';
|
|
|
|
if (isset($transceiver['IPI-CMM-CHASSIS-MIB::cmmTransExtEthCompliance']) && $transceiver['IPI-CMM-CHASSIS-MIB::cmmTransExtEthCompliance'] != 'unavailable') {
|
|
$description .= ' ' . str_replace('eec-', '', $transceiver['IPI-CMM-CHASSIS-MIB::cmmTransExtEthCompliance']);
|
|
} elseif (isset($transceiver['IPI-CMM-CHASSIS-MIB::cmmTransEthCompliance']) && $transceiver['IPI-CMM-CHASSIS-MIB::cmmTransEthCompliance'] != 'unavailable') {
|
|
$description .= ' ' . str_replace('ec-', '', $transceiver['IPI-CMM-CHASSIS-MIB::cmmTransEthCompliance']);
|
|
}
|
|
|
|
if (isset($transceiver['IPI-CMM-CHASSIS-MIB::cmmTransLengthKmtrs']) && $transceiver['IPI-CMM-CHASSIS-MIB::cmmTransLengthKmtrs'] > 0) {
|
|
$description .= ' ' . $transceiver['IPI-CMM-CHASSIS-MIB::cmmTransLengthKmtrs'] . 'km';
|
|
} elseif (isset($transceiver['IPI-CMM-CHASSIS-MIB::cmmTransLengthMtrs']) && $transceiver['IPI-CMM-CHASSIS-MIB::cmmTransLengthMtrs'] > 0) {
|
|
$description .= ' ' . $transceiver['IPI-CMM-CHASSIS-MIB::cmmTransLengthMtrs'] . 'm';
|
|
} elseif (isset($transceiver['IPI-CMM-CHASSIS-MIB::cmmTransLengthOM4']) && $transceiver['IPI-CMM-CHASSIS-MIB::cmmTransLengthOM4'] > 0) {
|
|
$description .= ' ' . $transceiver['IPI-CMM-CHASSIS-MIB::cmmTransLengthOM4'] . 'm';
|
|
} elseif (isset($transceiver['IPI-CMM-CHASSIS-MIB::cmmTransLengthOM3']) && $transceiver['IPI-CMM-CHASSIS-MIB::cmmTransLengthOM3'] > 0) {
|
|
$description .= ' ' . $transceiver['IPI-CMM-CHASSIS-MIB::cmmTransLengthOM3'] . 'm';
|
|
} elseif (isset($transceiver['IPI-CMM-CHASSIS-MIB::cmmTransLengthOM2']) && $transceiver['IPI-CMM-CHASSIS-MIB::cmmTransLengthOM2'] > 0) {
|
|
$description .= ' ' . $transceiver['IPI-CMM-CHASSIS-MIB::cmmTransLengthOM2'] . 'm';
|
|
} elseif (isset($transceiver['IPI-CMM-CHASSIS-MIB::cmmTransLengthOM1']) && $transceiver['IPI-CMM-CHASSIS-MIB::cmmTransLengthOM1'] > 0) {
|
|
$description .= ' ' . $transceiver['IPI-CMM-CHASSIS-MIB::cmmTransLengthOM1'] . 'm';
|
|
}
|
|
|
|
return $description;
|
|
}
|
|
|
|
public function guessIfName($cmmTransIndex, $cmmTransType): ?string
|
|
{
|
|
// IP Infusion has no reliable way of mapping a transceiver to a port it varies by hardware
|
|
|
|
$prefix = match ($cmmTransType) {
|
|
'sfp' => 'xe',
|
|
'qsfp' => 'ce',
|
|
default => 'ge',
|
|
};
|
|
|
|
return match ($this->getDevice()->hardware) {
|
|
'Ufi Space S9600-32X-R' => $prefix . ($this->portBreakoutEnabled() ? ($cmmTransType == 'qsfp' ? $cmmTransIndex - 5 : $cmmTransIndex - 2) : $cmmTransIndex - 1),
|
|
'Ufi Space S9510-28DC-B' => $prefix . ($cmmTransIndex - 1),
|
|
'Ufi Space S9500-30XS-P' => $prefix . ($cmmTransType == 'qsfp' ? $cmmTransIndex - 29 : $cmmTransIndex - 1),
|
|
'Edgecore 7316-26XB-O-48V-F' => $prefix . ($cmmTransType == 'qsfp' ? $cmmTransIndex - 1 : $cmmTransIndex - 3),
|
|
'Edgecore 5912-54X-O-AC-F' => $prefix . $cmmTransIndex,
|
|
'Edgecore 7712-32X-O-AC-F' => $prefix . $cmmTransIndex . '/1',
|
|
default => null, // no port map, so we can't guess
|
|
};
|
|
}
|
|
|
|
public function discoverTransceivers(): Collection
|
|
{
|
|
return SnmpQuery::enumStrings()->walk('IPI-CMM-CHASSIS-MIB::cmmTransEEPROMTable')->mapTable(function ($data, $cmmStackUnitIndex, $cmmTransIndex) {
|
|
$distance = 0;
|
|
if (! empty($data['IPI-CMM-CHASSIS-MIB::cmmTransLengthMtrs']) && $data['IPI-CMM-CHASSIS-MIB::cmmTransLengthMtrs'] !== '-100002') {
|
|
$distance = (int) $data['IPI-CMM-CHASSIS-MIB::cmmTransLengthMtrs'];
|
|
} elseif (! empty($data['IPI-CMM-CHASSIS-MIB::cmmTransLengthKmtrs']) && $data['IPI-CMM-CHASSIS-MIB::cmmTransLengthKmtrs'] !== '-100002') {
|
|
$distance = $data['IPI-CMM-CHASSIS-MIB::cmmTransLengthKmtrs'] * 1000;
|
|
} elseif (! empty($data['IPI-CMM-CHASSIS-MIB::cmmTransLengthOM4']) && $data['IPI-CMM-CHASSIS-MIB::cmmTransLengthOM4'] !== '-100002') {
|
|
$distance = (int) $data['IPI-CMM-CHASSIS-MIB::cmmTransLengthOM4'];
|
|
} elseif (! empty($data['IPI-CMM-CHASSIS-MIB::cmmTransLengthOM3']) && $data['IPI-CMM-CHASSIS-MIB::cmmTransLengthOM3'] !== '-100002') {
|
|
$distance = (int) $data['IPI-CMM-CHASSIS-MIB::cmmTransLengthOM3'];
|
|
} elseif (! empty($data['IPI-CMM-CHASSIS-MIB::cmmTransLengthOM2']) && $data['IPI-CMM-CHASSIS-MIB::cmmTransLengthOM2'] !== '-100002') {
|
|
$distance = (int) $data['IPI-CMM-CHASSIS-MIB::cmmTransLengthOM2'];
|
|
} elseif (! empty($data['IPI-CMM-CHASSIS-MIB::cmmTransLengthOM1']) && $data['IPI-CMM-CHASSIS-MIB::cmmTransLengthOM1'] !== '-100002') {
|
|
$distance = (int) $data['IPI-CMM-CHASSIS-MIB::cmmTransLengthOM1'];
|
|
}
|
|
|
|
$connector = match ($data['IPI-CMM-CHASSIS-MIB::cmmTransconnectortype'] ?? null) {
|
|
'bayonet-or-threaded-neill-concelman' => 'ST',
|
|
'copper-pigtail' => 'DAC',
|
|
'fiber-jack' => 'FJ',
|
|
'fibrechannel-style1-copperconnector', 'fibrechannel-style2-copperconnector', 'fibrechannel-coaxheaders' => 'FC',
|
|
'hssdcii' => 'HSSDC',
|
|
'lucent-connector' => 'LC',
|
|
'mechanical-transfer-registeredjack' => 'MTRJ',
|
|
'multifiber-paralleloptic-1x12' => 'MPO-12',
|
|
'multifiber-paralleloptic-1x16' => 'MPO-16',
|
|
'multiple-optical' => 'MPO',
|
|
'mxc2-x16' => 'MXC2-X16',
|
|
'no-separable-connector' => 'None',
|
|
'optical-pigtail' => 'AOC',
|
|
'rj45' => 'RJ45',
|
|
'sg' => 'SG',
|
|
'subscriber-connector' => 'SC',
|
|
default => 'unknown',
|
|
};
|
|
|
|
$date = $data['IPI-CMM-CHASSIS-MIB::cmmTransDateCode'] ?? '0000-00-00';
|
|
if (preg_match('/^(\d{2,4})(\d{2})(\d{2})$/', $date, $date_matches)) {
|
|
$year = $date_matches[1];
|
|
if (strlen($year) == 2) {
|
|
$year = '20' . $year;
|
|
}
|
|
$date = $year . '-' . $date_matches[2] . '-' . $date_matches[3];
|
|
}
|
|
|
|
$cmmTransType = $data['IPI-CMM-CHASSIS-MIB::cmmTransType'] ?? 'missing';
|
|
|
|
if ($this->ifNamePortIdMap === null) {
|
|
$this->ifNamePortIdMap = $this->getDevice()->ports()->toBase()->pluck('port_id', 'ifName');
|
|
}
|
|
|
|
return new Transceiver([
|
|
'port_id' => $this->ifNamePortIdMap[$this->guessIfName($cmmTransIndex, $cmmTransType)] ?? 0,
|
|
'index' => "$cmmStackUnitIndex.$cmmTransIndex",
|
|
'type' => $cmmTransType,
|
|
'vendor' => $data['IPI-CMM-CHASSIS-MIB::cmmTransVendorName'] ?? 'missing',
|
|
'oui' => $data['IPI-CMM-CHASSIS-MIB::cmmTransVendorOUI'] ?? 'missing',
|
|
'model' => $data['IPI-CMM-CHASSIS-MIB::cmmTransVendorPartNumber'] ?? 'missing',
|
|
'revision' => $data['IPI-CMM-CHASSIS-MIB::cmmTransVendorRevision'] ?? 'missing',
|
|
'serial' => $data['IPI-CMM-CHASSIS-MIB::cmmTransVendorSerialNumber'] ?? 'missing',
|
|
'date' => $date,
|
|
'ddm' => isset($data['IPI-CMM-CHASSIS-MIB::cmmTransDDMSupport']) && $data['IPI-CMM-CHASSIS-MIB::cmmTransDDMSupport'] == 'yes',
|
|
'encoding' => $data['IPI-CMM-CHASSIS-MIB::cmmTransEncoding'] ?? 'missing',
|
|
'distance' => $distance,
|
|
'wavelength' => isset($data['IPI-CMM-CHASSIS-MIB::cmmTransWavelength']) && $data['IPI-CMM-CHASSIS-MIB::cmmTransWavelength'] !== '-100002' ? $data['IPI-CMM-CHASSIS-MIB::cmmTransWavelength'] : null,
|
|
'connector' => $connector,
|
|
'channels' => $data['IPI-CMM-CHASSIS-MIB::cmmTransNoOfChannels'] ?? 0,
|
|
'entity_physical_index' => $cmmStackUnitIndex * 10000 + $cmmTransIndex,
|
|
]);
|
|
});
|
|
}
|
|
|
|
private function portBreakoutEnabled(): bool
|
|
{
|
|
// Handle UfiSpace S9600 10G breakout, which is optionally enabled
|
|
if ($this->portBreakoutEnabled === null) {
|
|
// check for xe ports in ifTable
|
|
$this->portBreakoutEnabled = $this->getDevice()->ports()->exists()
|
|
? $this->getDevice()->ports()->where('ifName', 'LIKE', 'xe%')->exists() // ports module has run
|
|
: str_contains(SnmpQuery::cache()->walk('IF-MIB::ifName')->raw, 'xe'); // no ports in db
|
|
}
|
|
|
|
return $this->portBreakoutEnabled;
|
|
}
|
|
}
|