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
librenms-librenms/includes/snmp.inc.php

1111 lines
32 KiB
PHP
Raw Blame History

<?php
// If anybody has again the idea to implement the PHP internal library calls,
// be aware that it was tried and banned by lead dev Adam
//
// TRUE STORY. THAT SHIT IS WHACK. -- adama.
function string_to_oid($string)
{
$oid = strlen($string);
for($i = 0; $i != strlen($string); $i++)
{
$oid .= ".".ord($string[$i]);
}
return $oid;
}
function mibdir($mibdir)
{
global $config;
return " -M " . ($mibdir ? $mibdir : $config['mibdir']);
}
function snmp_get_multi($device, $oids, $options = "-OQUs", $mib = NULL, $mibdir = NULL)
{
global $debug,$config,$runtime_stats,$mibs_loaded;
if (is_numeric($device['timeout']) && $device['timeout'] > 0)
{
$timeout = $device['timeout'];
} elseif (isset($config['snmp']['timeout'])) {
$timeout = $config['snmp']['timeout'];
}
if (is_numeric($device['retries']) && $device['retries'] > 0)
{
$retries = $device['retries'];
} elseif (isset($config['snmp']['retries'])) {
$retries = $config['snmp']['retries'];
}
if (!isset($device['transport']))
{
$device['transport'] = "udp";
}
$cmd = $config['snmpget'];
$cmd .= snmp_gen_auth ($device);
if ($options) { $cmd .= " " . $options; }
if ($mib) { $cmd .= " -m " . $mib; }
$cmd .= mibdir($mibdir);
if (isset($timeout)) { $cmd .= " -t " . $timeout; }
if (isset($retries)) { $cmd .= " -r " . $retries; }
$cmd .= " ".$device['transport'].":".$device['hostname'].":".$device['port'];
$cmd .= " ".$oids;
if (!$debug) { $cmd .= " 2>/dev/null"; }
$data = trim(external_exec($cmd));
$runtime_stats['snmpget']++;
$array = array();
foreach (explode("\n", $data) as $entry)
{
list($oid,$value) = explode("=", $entry, 2);
$oid = trim($oid); $value = trim($value);
list($oid, $index) = explode(".", $oid,2);
if (!strstr($value, "at this OID") && isset($oid) && isset($index))
{
$array[$index][$oid] = $value;
}
}
return $array;
}
function snmp_get($device, $oid, $options = NULL, $mib = NULL, $mibdir = NULL)
{
global $debug,$config,$runtime_stats,$mibs_loaded;
if (is_numeric($device['timeout']) && $device['timeout'] > 0)
{
$timeout = $device['timeout'];
} elseif (isset($config['snmp']['timeout'])) {
$timeout = $config['snmp']['timeout'];
}
if (is_numeric($device['retries']) && $device['retries'] > 0)
{
$retries = $device['retries'];
} elseif (isset($config['snmp']['retries'])) {
$retries = $config['snmp']['retries'];
}
if (!isset($device['transport']))
{
$device['transport'] = "udp";
}
if (strstr($oid,' '))
{
echo(report_this_text("snmp_get called for multiple OIDs: $oid"));
}
$cmd = $config['snmpget'];
$cmd .= snmp_gen_auth ($device);
if ($options) { $cmd .= " " . $options; }
if ($mib) { $cmd .= " -m " . $mib; }
$cmd .= mibdir($mibdir);
if (isset($timeout)) { $cmd .= " -t " . $timeout; }
if (isset($retries)) { $cmd .= " -r " . $retries; }
$cmd .= " " . $device['transport'].":".$device['hostname'].":".$device['port'];
$cmd .= " " . $oid;
if (!$debug) { $cmd .= " 2>/dev/null"; }
$data = trim(external_exec($cmd));
$runtime_stats['snmpget']++;
if (is_string($data) && (preg_match("/(No Such Instance|No Such Object|No more variables left|Authentication failure)/i", $data)))
{
return false;
}
elseif ($data) { return $data; }
else { return false; }
}
function snmp_walk($device, $oid, $options = NULL, $mib = NULL, $mibdir = NULL)
{
global $debug,$config,$runtime_stats;
if (is_numeric($device['timeout']) && $device['timeout'] > 0)
{
$timeout = $device['timeout'];
} elseif (isset($config['snmp']['timeout']))
{
$timeout = $config['snmp']['timeout'];
}
if (is_numeric($device['retries']) && $device['retries'] > 0)
{
$retries = $device['retries'];
} elseif (isset($config['snmp']['retries'])) {
$retries = $config['snmp']['retries'];
}
if (!isset($device['transport']))
{
$device['transport'] = "udp";
}
if ($device['snmpver'] == 'v1' || $config['os'][$device['os']]['nobulk'])
{
$snmpcommand = $config['snmpwalk'];
}
else
{
$snmpcommand = $config['snmpbulkwalk'];
}
$cmd = $snmpcommand;
$cmd .= snmp_gen_auth ($device);
if ($options) { $cmd .= " $options "; }
if ($mib) { $cmd .= " -m $mib"; }
$cmd .= mibdir($mibdir);
if (isset($timeout)) { $cmd .= " -t " . $timeout; }
if (isset($retries)) { $cmd .= " -r " . $retries; }
$cmd .= " ".$device['transport'].":".$device['hostname'].":".$device['port']." ".$oid;
if (!$debug) { $cmd .= " 2>/dev/null"; }
$data = trim(external_exec($cmd));
$data = str_replace("\"", "", $data);
if (is_string($data) && (preg_match("/No Such (Object|Instance)/i", $data)))
{
$data = false;
}
else
{
if (preg_match("/No more variables left in this MIB View \(It is past the end of the MIB tree\)$/",$data)) {
# Bit ugly :-(
$d_ex = explode("\n",$data);
unset($d_ex[count($d_ex)-1]);
$data = implode("\n",$d_ex);
}
}
$runtime_stats['snmpwalk']++;
return $data;
}
function snmpwalk_cache_cip($device, $oid, $array = array(), $mib = 0)
{
global $config;
if (is_numeric($device['timeout']) && $device['timeout'] > 0)
{
$timeout = $device['timeout'];
} elseif (isset($config['snmp']['timeout'])) {
$timeout = $config['snmp']['timeout'];
}
if (is_numeric($device['retries']) && $device['retries'] > 0)
{
$retries = $device['retries'];
} elseif (isset($config['snmp']['retries'])) {
$retries = $config['snmp']['retries'];
}
if (!isset($device['transport'])) { $device['transport'] = "udp"; }
if ($device['snmpver'] == 'v1' || $config['os'][$device['os']]['nobulk'])
{
$snmpcommand = $config['snmpwalk'];
}
else
{
$snmpcommand = $config['snmpbulkwalk'];
}
$cmd = $snmpcommand;
$cmd .= snmp_gen_auth ($device);
$cmd .= " -O snQ";
if ($mib) { $cmd .= " -m $mib"; }
$cmd .= mibdir(null);
if (isset($timeout)) { $cmd .= " -t " . $timeout; }
if (isset($retries)) { $cmd .= " -r " . $retries; }
$cmd .= " ".$device['transport'].":".$device['hostname'].":".$device['port']." ".$oid;
if (!$debug) { $cmd .= " 2>/dev/null"; }
$data = trim(external_exec($cmd));
$device_id = $device['device_id'];
#echo("Caching: $oid\n");
foreach (explode("\n", $data) as $entry)
{
list ($this_oid, $this_value) = preg_split("/=/", $entry);
$this_oid = trim($this_oid);
$this_value = trim($this_value);
$this_oid = substr($this_oid, 30);
list($ifIndex,$dir,$a,$b,$c,$d,$e,$f) = explode(".", $this_oid);
$h_a = zeropad(dechex($a));
$h_b = zeropad(dechex($b));
$h_c = zeropad(dechex($c));
$h_d = zeropad(dechex($d));
$h_e = zeropad(dechex($e));
$h_f = zeropad(dechex($f));
$mac = "$h_a$h_b$h_c$h_d$h_e$h_f";
if ($dir == "1") { $dir = "input"; } elseif ($dir == "2") { $dir = "output"; }
if ($mac && $dir)
{
$array[$ifIndex][$mac][$oid][$dir] = $this_value;
}
}
return $array;
}
function snmp_cache_ifIndex($device)
{
// FIXME: this is not yet using our own snmp_*
global $config;
if (is_numeric($device['timeout']) && $device['timeout'] > 0)
{
$timeout = $device['timeout'];
} elseif (isset($config['snmp']['timeout'])) {
$timeout = $config['snmp']['timeout'];
}
if (is_numeric($device['retries']) && $device['retries'] > 0)
{
$retries = $device['retries'];
} elseif (isset($config['snmp']['retries'])) {
$retries = $config['snmp']['retries'];
}
if (!isset($device['transport'])) { $device['transport'] = "udp"; }
if ($device['snmpver'] == 'v1' || $config['os'][$device['os']]['nobulk'])
{
$snmpcommand = $config['snmpwalk'];
}
else
{
$snmpcommand = $config['snmpbulkwalk'];
}
$cmd = $snmpcommand;
$cmd .= snmp_gen_auth ($device);
$cmd .= " -O Qs";
$cmd .= mibdir(null);
$cmd .= " -m IF-MIB ifIndex";
if (isset($timeout)) { $cmd .= " -t " . $timeout; }
if (isset($retries)) { $cmd .= " -r " . $retries; }
if (!$debug) { $cmd .= " 2>/dev/null"; }
$data = trim(external_exec($cmd));
$device_id = $device['device_id'];
foreach (explode("\n", $data) as $entry)
{
list ($this_oid, $this_value) = preg_split("/=/", $entry);
list ($this_oid, $this_index) = explode(".", $this_oid, 2);
$this_index = trim($this_index);
$this_oid = trim($this_oid);
$this_value = trim($this_value);
if (!strstr($this_value, "at this OID") && $this_index)
{
$array[] = $this_value;
}
}
return $array;
}
function snmpwalk_cache_oid($device, $oid, $array, $mib = NULL, $mibdir = NULL, $snmpflags = "-OQUs")
{
$data = snmp_walk($device, $oid, $snmpflags, $mib, $mibdir);
foreach (explode("\n", $data) as $entry)
{
list($oid,$value) = explode("=", $entry, 2);
$oid = trim($oid); $value = trim($value);
list($oid, $index) = explode(".", $oid, 2);
if (!strstr($value, "at this OID") && isset($oid) && isset($index))
{
$array[$index][$oid] = $value;
}
}
return $array;
}
// just like snmpwalk_cache_oid except that it returns the numerical oid as the index
// this is useful when the oid is indexed by the mac address and snmpwalk would
// return periods (.) for non-printable numbers, thus making many different indexes appear
// to be the same.
function snmpwalk_cache_oid_num($device, $oid, $array, $mib = NULL, $mibdir = NULL)
{
return snmpwalk_cache_oid($device, $oid, $array, $mib, $mibdir, $snmpflags = "-OQUn");
}
function snmpwalk_cache_multi_oid($device, $oid, $array, $mib = NULL, $mibdir = NULL)
{
global $cache;
if (!(is_array($cache['snmp'][$device['device_id']]) && array_key_exists($oid,$cache['snmp'][$device['device_id']])))
{
$data = snmp_walk($device, $oid, "-OQUs", $mib, $mibdir);
foreach (explode("\n", $data) as $entry)
{
list($r_oid,$value) = explode("=", $entry, 2);
$r_oid = trim($r_oid); $value = trim($value);
$oid_parts = explode(".", $r_oid);
$r_oid = $oid_parts['0'];
$index = $oid_parts['1'];
if (isset($oid_parts['2'])) { $index .= ".".$oid_parts['2']; }
if (isset($oid_parts['3'])) { $index .= ".".$oid_parts['3']; }
if (isset($oid_parts['4'])) { $index .= ".".$oid_parts['4']; }
if (isset($oid_parts['5'])) { $index .= ".".$oid_parts['5']; }
if (isset($oid_parts['6'])) { $index .= ".".$oid_parts['6']; }
if (!strstr($value, "at this OID") && isset($r_oid) && isset($index))
{
$array[$index][$r_oid] = $value;
}
}
$cache['snmp'][$device['device_id']][$oid] = $array;
}
return $cache['snmp'][$device['device_id']][$oid];
}
function snmpwalk_cache_double_oid($device, $oid, $array, $mib = NULL, $mibdir = NULL)
{
$data = snmp_walk($device, $oid, "-OQUs", $mib, $mibdir);
foreach (explode("\n", $data) as $entry)
{
list($oid,$value) = explode("=", $entry, 2);
$oid = trim($oid); $value = trim($value);
list($oid, $first, $second) = explode(".", $oid);
if (!strstr($value, "at this OID") && isset($oid) && isset($first) && isset($second))
{
$double = $first.".".$second;
$array[$double][$oid] = $value;
}
}
return $array;
}
function snmpwalk_cache_triple_oid($device, $oid, $array, $mib = NULL, $mibdir = NULL)
{
$data = snmp_walk($device, $oid, "-OQUs", $mib, $mibdir);
foreach (explode("\n", $data) as $entry)
{
list($oid,$value) = explode("=", $entry, 2);
$oid = trim($oid); $value = trim($value);
list($oid, $first, $second, $third) = explode(".", $oid);
if (!strstr($value, "at this OID") && isset($oid) && isset($first) && isset($second))
{
$index = $first.".".$second.".".$third;
$array[$index][$oid] = $value;
}
}
return $array;
}
function snmpwalk_cache_twopart_oid($device, $oid, $array, $mib = 0)
{
global $config;
if (is_numeric($device['timeout']) && $device['timeout'] > 0)
{
$timeout = $device['timeout'];
} elseif (isset($config['snmp']['timeout'])) {
$timeout = $config['snmp']['timeout'];
}
if (is_numeric($device['retries']) && $device['retries'] > 0)
{
$retries = $device['retries'];
} elseif (isset($config['snmp']['retries'])) {
$retries = $config['snmp']['retries'];
}
if (!isset($device['transport']))
{
$device['transport'] = "udp";
}
if ($device['snmpver'] == 'v1' || $config['os'][$device['os']]['nobulk'])
{
$snmpcommand = $config['snmpwalk'];
}
else
{
$snmpcommand = $config['snmpbulkwalk'];
}
$cmd = $snmpcommand;
$cmd .= snmp_gen_auth ($device);
$cmd .= " -O QUs";
$cmd .= mibdir(null);
if ($mib) { $cmd .= " -m $mib"; }
if (isset($timeout)) { $cmd .= " -t " . $timeout; }
if (isset($retries)) { $cmd .= " -r " . $retries; }
$cmd .= " ".$device['transport'].":".$device['hostname'].":".$device['port']." ".$oid;
if (!$debug) { $cmd .= " 2>/dev/null"; }
$data = trim(external_exec($cmd));
$device_id = $device['device_id'];
foreach (explode("\n", $data) as $entry)
{
list($oid,$value) = explode("=", $entry, 2);
$oid = trim($oid); $value = trim($value); $value = str_replace("\"", "", $value);
list($oid, $first, $second) = explode(".", $oid);
if (!strstr($value, "at this OID") && isset($oid) && isset($first) && isset($second))
{
$array[$first][$second][$oid] = $value;
}
}
return $array;
}
function snmpwalk_cache_threepart_oid($device, $oid, $array, $mib = 0)
{
global $config, $debug;
if (is_numeric($device['timeout']) && $device['timeout'] > 0)
{
$timeout = $device['timeout'];
} elseif (isset($config['snmp']['timeout'])) {
$timeout = $config['snmp']['timeout'];
}
if (is_numeric($device['retries']) && $device['retries'] > 0)
{
$retries = $device['retries'];
} elseif (isset($config['snmp']['retries'])) {
$retries = $config['snmp']['retries'];
}
if (!isset($device['transport']))
{
$device['transport'] = "udp";
}
if ($device['snmpver'] == 'v1' || $config['os'][$device['os']]['nobulk'])
{
$snmpcommand = $config['snmpwalk'];
}
else
{
$snmpcommand = $config['snmpbulkwalk'];
}
$cmd = $snmpcommand;
$cmd .= snmp_gen_auth ($device);
$cmd .= " -O QUs";
$cmd .= mibdir(null);
if ($mib) { $cmd .= " -m $mib"; }
if (isset($timeout)) { $cmd .= " -t " . $timeout; }
if (isset($retries)) { $cmd .= " -r " . $retries; }
$cmd .= " ".$device['transport'].":".$device['hostname'].":".$device['port']." ".$oid;
if (!$debug) { $cmd .= " 2>/dev/null"; }
$data = trim(external_exec($cmd));
$device_id = $device['device_id'];
foreach (explode("\n", $data) as $entry)
{
list($oid,$value) = explode("=", $entry, 2);
$oid = trim($oid); $value = trim($value); $value = str_replace("\"", "", $value);
list($oid, $first, $second, $third) = explode(".", $oid);
if ($debug) {echo("$entry || $oid || $first || $second || $third\n"); }
if (!strstr($value, "at this OID") && isset($oid) && isset($first) && isset($second) && isset($third))
{
$array[$first][$second][$third][$oid] = $value;
}
}
return $array;
}
function snmp_cache_slotport_oid($oid, $device, $array, $mib = 0)
{
global $config;
if (is_numeric($device['timeout']) && $device['timeout'] > 0)
{
$timeout = $device['timeout'];
} elseif (isset($config['snmp']['timeout'])) {
$timeout = $config['snmp']['timeout'];
}
if (is_numeric($device['retries']) && $device['retries'] > 0)
{
$retries = $device['retries'];
} elseif (isset($config['snmp']['retries'])) {
$retries = $config['snmp']['retries'];
}
if (!isset($device['transport']))
{
$device['transport'] = "udp";
}
if ($device['snmpver'] == 'v1' || $config['os'][$device['os']]['nobulk'])
{
$snmpcommand = $config['snmpwalk'];
}
else
{
$snmpcommand = $config['snmpbulkwalk'];
}
$cmd = $snmpcommand;
$cmd .= snmp_gen_auth ($device);
$cmd .= " -O QUs";
if ($mib) { $cmd .= " -m $mib"; }
$cmd .= mibdir(null);
if (isset($timeout)) { $cmd .= " -t " . $timeout; }
if (isset($retries)) { $cmd .= " -r " . $retries; }
$cmd .= " ".$device['transport'].":".$device['hostname'].":".$device['port']." ".$oid;
if (!$debug) { $cmd .= " 2>/dev/null"; }
$data = trim(external_exec($cmd));
$device_id = $device['device_id'];
foreach (explode("\n", $data) as $entry)
{
$entry = str_replace($oid.".", "", $entry);
list($slotport, $value) = explode("=", $entry, 2);
$slotport = trim($slotport); $value = trim($value);
if ($array[$slotport]['ifIndex'])
{
$ifIndex = $array[$slotport]['ifIndex'];
$array[$ifIndex][$oid] = $value;
}
}
return $array;
}
function snmp_cache_oid($oid, $device, $array, $mib = 0)
{
$array = snmpwalk_cache_oid($device, $oid, $array, $mib);
return $array;
}
function snmp_cache_port_oids($oids, $port, $device, $array, $mib=0)
{
global $config;
if (is_numeric($device['timeout']) && $device['timeout'] > 0)
{
$timeout = $device['timeout'];
} elseif (isset($config['snmp']['timeout'])) {
$timeout = $config['snmp']['timeout'];
}
if (is_numeric($device['retries']) && $device['retries'] > 0)
{
$retries = $device['retries'];
} elseif (isset($config['snmp']['retries'])) {
$retries = $config['snmp']['retries'];
}
if (!isset($device['transport']))
{
$device['transport'] = "udp";
}
foreach ($oids as $oid)
{
$string .= " $oid.$port";
}
$cmd = $config['snmpget'];
$cmd .= snmp_gen_auth ($device);
$cmd .= " -O vq";
if (isset($timeout)) { $cmd .= " -t " . $timeout; }
if (isset($retries)) { $cmd .= " -r " . $retries; }
$cmd .= mibdir(null);
if ($mib) { $cmd .= " -m $mib"; }
$cmd .= " -t " . $timeout . " -r " . $retries;
$cmd .= " ".$device['transport'].":".$device['hostname'].":".$device['port']." ".$string;
if (!$debug) { $cmd .= " 2>/dev/null"; }
$data = trim(external_exec($cmd));
$x=0;
$values = explode("\n", $data);
#echo("Caching: ifIndex $port\n");
foreach ($oids as $oid) {
if (!strstr($values[$x], "at this OID"))
{
$array[$port][$oid] = $values[$x];
}
$x++;
}
return $array;
}
function snmp_cache_portIfIndex($device, $array)
{
global $config;
if (is_numeric($device['timeout']) && $device['timeout'] > 0)
{
$timeout = $device['timeout'];
} elseif (isset($config['snmp']['timeout'])) {
$timeout = $config['snmp']['timeout'];
}
if (is_numeric($device['retries']) && $device['retries'] > 0)
{
$retries = $device['retries'];
} elseif (isset($config['snmp']['retries'])) {
$retries = $config['snmp']['retries'];
}
if (!isset($device['transport']))
{
$device['transport'] = "udp";
}
$cmd = $config['snmpwalk'];
$cmd .= snmp_gen_auth ($device);
$cmd .= " -CI -m CISCO-STACK-MIB -O q";
$cmd .= mibdir(null);
if (isset($timeout)) { $cmd .= " -t " . $timeout; }
if (isset($retries)) { $cmd .= " -r " . $retries; }
$cmd .= " ".$device['transport'].":".$device['hostname'].":".$device['port']." portIfIndex";
$output = trim(external_exec($cmd));
$device_id = $device['device_id'];
foreach (explode("\n", $output) as $entry)
{
$entry = str_replace("CISCO-STACK-MIB::portIfIndex.", "", $entry);
list($slotport, $ifIndex) = explode(" ", $entry, 2);
if ($slotport && $ifIndex) {
$array[$ifIndex]['portIfIndex'] = $slotport;
$array[$slotport]['ifIndex'] = $ifIndex;
}
}
return $array;
}
function snmp_cache_portName($device, $array)
{
global $config;
if (is_numeric($device['timeout']) && $device['timeout'] > 0)
{
$timeout = $device['timeout'];
} elseif (isset($config['snmp']['timeout'])) {
$timeout = $config['snmp']['timeout'];
}
if (is_numeric($device['retries']) && $device['retries'] > 0)
{
$retries = $device['retries'];
} elseif (isset($config['snmp']['retries'])) {
$retries = $config['snmp']['retries'];
}
if (!isset($device['transport']))
{
$device['transport'] = "udp";
}
$cmd = $config['snmpwalk'];
$cmd .= snmp_gen_auth ($device);
$cmd .= " -CI -m CISCO-STACK-MIB -O Qs";
$cmd .= mibdir(null);
if (isset($timeout)) { $cmd .= " -t " . $timeout; }
if (isset($retries)) { $cmd .= " -r " . $retries; }
$cmd .= " ".$device['transport'].":".$device['hostname'].":".$device['port']." portName";
$output = trim(external_exec($cmd));
$device_id = $device['device_id'];
#echo("Caching: portName\n");
foreach (explode("\n", $output) as $entry)
{
$entry = str_replace("portName.", "", $entry);
list($slotport, $portName) = explode("=", $entry, 2);
$slotport = trim($slotport); $portName = trim($portName);
if ($array[$slotport]['ifIndex'])
{
$ifIndex = $array[$slotport]['ifIndex'];
$array[$slotport]['portName'] = $portName;
$array[$ifIndex]['portName'] = $portName;
}
}
return $array;
}
function snmp_gen_auth (&$device)
{
global $debug;
$cmd = "";
if ($device['snmpver'] === "v3")
{
$cmd = " -v3 -n \"\" -l " . $device['authlevel'];
if ($device['authlevel'] === "noAuthNoPriv")
{
// We have to provide a username anyway (see Net-SNMP doc)
// FIXME: There are two other places this is set - why are they ignored here?
$cmd .= " -u root";
}
elseif ($device['authlevel'] === "authNoPriv")
{
$cmd .= " -a " . $device['authalgo'];
$cmd .= " -A \"" . $device['authpass'] . "\"";
$cmd .= " -u " . $device['authname'];
}
elseif ($device['authlevel'] === "authPriv")
{
$cmd .= " -a " . $device['authalgo'];
$cmd .= " -A \"" . $device['authpass'] . "\"";
$cmd .= " -u " . $device['authname'];
$cmd .= " -x " . $device['cryptoalgo'];
$cmd .= " -X \"" . $device['cryptopass'] . "\"";
}
else
{
if ($debug) { print "DEBUG: " . $device['snmpver'] ." : Unsupported SNMPv3 AuthLevel (wtf have you done ?)\n"; }
}
}
elseif ($device['snmpver'] === "v2c" or $device['snmpver'] === "v1")
{
$cmd = " -" . $device['snmpver'];
$cmd .= " -c " . $device['community'];
}
else
{
if ($debug) { print "DEBUG: " . $device['snmpver'] ." : Unsupported SNMP Version (wtf have you done ?)\n"; }
}
if ($debug) { print "DEBUG: SNMP Auth options = $cmd\n"; }
return $cmd;
}
/*
* Shorten the name to so it works as an RRD data source.
* Substitute for $subst if necessary.
* @return the shortened name
*/
function name_shorten($name, $common, $subst = "mibval", $len = 19)
{
if (strlen($name) > $len && strpos($name, $common) >= 0) {
$newname = str_replace($common, '', $name);
$name = $newname;
}
if (strlen($name) > $len) {
$name = $subst;
}
return $name;
}
/*
* Translate the given MIB into a vaguely useful PHP array. Each keyword becomes an array index.
*
* Example:
* snmptranslate -Td -On -M mibs -m RUCKUS-ZD-SYSTEM-MIB RUCKUS-ZD-SYSTEM-MIB::ruckusZDSystemStatsNumSta
* .1.3.6.1.4.1.25053.1.2.1.1.1.15.30
* ruckusZDSystemStatsAllNumSta OBJECT-TYPE
* -- FROM RUCKUS-ZD-SYSTEM-MIB
* SYNTAX Unsigned32
* MAX-ACCESS read-only
* STATUS current
* DESCRIPTION "Number of All client devices"
* ::= { iso(1) org(3) dod(6) internet(1) private(4) enterprises(1) ruckusRootMIB(25053) ruckusObjects(1) ruckusZD(2) ruckusZDSystemModule(1) ruckusZDSystemMIB(1) ruckusZDSystemObjects(1)
* ruckusZDSystemStats(15) 30 }
*/
function snmp_mib_parse($oid, $mib, $module, $mibdir = null)
{
global $debug;
$lastpart = end(explode(".", $oid));
$cmd = "snmptranslate -Td -On";
$cmd .= mibdir($mibdir);
$cmd .= " -m ".$module." ".$module."::";
$cmd .= $lastpart;
$result = array();
$lines = preg_split('/\n+/', trim(shell_exec($cmd)));
foreach ($lines as $l) {
$f = preg_split('/\s+/', trim($l));
// first line is all numeric
if (preg_match('/^[\d.]+$/', $f[0])) {
$result['oid'] = $f[0];
continue;
}
// then the name of the object type
if ($f[1] && $f[1] == "OBJECT-TYPE") {
$result['object_type'] = $f[0];
$result['shortname'] = str_replace($mib, '', $f[0]);
$result['dsname'] = name_shorten($f[0], $mib);
continue;
}
// then the other data elements
if ($f[0] == "--" && $f[1] == "FROM") {
$result['module'] = $f[2];
continue;
}
if ($f[0] == "MAX-ACCESS") {
$result['max_access'] = $f[1];
continue;
}
if ($f[0] == "STATUS") {
$result[strtolower($f[0])] = $f[1];
continue;
}
if ($f[0] == "SYNTAX") {
$result[strtolower($f[0])] = $f[1];
continue;
}
if ($f[0] == "DESCRIPTION") {
$desc = explode('"', $l);
if ($desc[1]) {
$str = preg_replace('/^[\s.]*/', '', $desc[1]);
$str = preg_replace('/[\s.]*$/', '', $str);
$result[strtolower($f[0])] = $str;
}
continue;
}
}
// The main mib entry doesn't have any useful data in it - only return items that have the syntax specified.
if (isset($result['syntax']) && isset($result['object_type'])) {
$result['mib'] = $mib;
return $result;
}
else {
return null;
}
}
/*
* Walks through the given MIB module, looking for the given MIB.
* NOTE: different from snmp walk - this doesn't touch the device.
* NOTE: There's probably a better way to do this with snmptranslate.
*
* Example:
* snmptranslate -Ts -M mibs -m RUCKUS-ZD-SYSTEM-MIB | grep ruckusZDSystemStats
* .iso.org.dod.internet.private.enterprises.ruckusRootMIB.ruckusObjects.ruckusZD.ruckusZDSystemModule.ruckusZDSystemMIB.ruckusZDSystemObjects.ruckusZDSystemStats
* .iso.org.dod.internet.private.enterprises.ruckusRootMIB.ruckusObjects.ruckusZD.ruckusZDSystemModule.ruckusZDSystemMIB.ruckusZDSystemObjects.ruckusZDSystemStats.ruckusZDSystemStatsNumAP
* .iso.org.dod.internet.private.enterprises.ruckusRootMIB.ruckusObjects.ruckusZD.ruckusZDSystemModule.ruckusZDSystemMIB.ruckusZDSystemObjects.ruckusZDSystemStats.ruckusZDSystemStatsNumSta
* ...
*/
function snmp_mib_walk($mib, $module, $mibdir = null)
{
$cmd = "snmptranslate -Ts";
$cmd .= mibdir($mibdir);
$cmd .= " -m ".$module;
$result = array();
$data = preg_split('/\n+/', shell_exec($cmd));
foreach ($data as $oid) {
// only include oids which are part of this mib
if (strstr($oid, $mib)) {
$obj = snmp_mib_parse($oid, $mib, $module, $mibdir);
if ($obj) {
$result[] = $obj;
}
}
}
return $result;
}
/*
* @return an array containing all of the mib objects, keyed by object-type;
* returns an empty array if something goes wrong.
*/
function snmp_mib_load($mib, $module, $mibdir = null)
{
$mibs = array();
foreach (snmp_mib_walk($mib, $module, $mibdir) as $obj) {
$mibs[$obj['object_type']] = $obj;
}
return $mibs;
}
/*
* Turn the given oid (name or numeric value) into a MODULE::mib name.
* @return an array consisting of the module and mib names, or null if no matching MIB is found.
*/
function snmp_translate($oid, $module, $mibdir = null)
{
if ($module !== "all") {
$oid = "$module::$oid";
}
$cmd = "snmptranslate" . mibdir($mibdir);
$cmd .= " -m $module $oid"; // load all the MIBs looking for our object
$cmd .= " 2>/dev/null"; // ignore invalid MIBs
$lines = preg_split('/\n+/', shell_exec($cmd));
if (!$lines) {
d_echo("No results from snmptranslate");
return null;
}
$matches = array();
if (!preg_match('/(.*)::(.*)/', $lines[0], $matches)) {
d_echo("This doesn't look like a MIB: ".$lines[0]);
return null;
}
d_echo("SNMP translated: $module::$oid -> $matches[1]::$matches[2]");
return array($matches[1], $matches[2]);
}
/*
* check if the type of the oid is a numeric type, and if so,
* @return the name of RRD type that is best suited to saving it
*/
function oid_rrd_type($oid, $mibdef) {
if (!isset($mibdef[$oid])) {
return false;
}
switch ($mibdef[$oid]['syntax']) {
case 'OCTET':
case 'IpAddress':
return false;
case 'TimeTicks':
// Need to find a way to flag that this should be parsed
//return 'COUNTER';
return false;
case 'Counter64':
return 'COUNTER:600:0:U';
case 'Unsigned32':
return 'GAUGE:600:U:U';
}
return false;
}
/*
* Construct a graph names for use in the database.
* Tag each as in use on this device in &$graphs.
* Update the database with graph definitions as needed.
* We don't include the index in the graph name - that is handled at display time.
*/
function tag_graphs($mibname, $oids, $mibdef, &$graphs)
{
foreach ($oids as $index => $array) {
foreach ($array as $oid => $val) {
$graphname = $mibname."-".$mibdef[$oid]['shortname'];
$graphs[$graphname] = true;
}
}
}
/*
* Ensure a graph_type definition exists in the database for the entities in this MIB
*/
function update_mib_graph_types($mibname, $oids, $mibdef, $graphs)
{
$seengraphs = array();
// Get the list of graphs currently in the database
// FIXME: there's probably a more efficient way to do this
foreach (dbFetch("SELECT DISTINCT `graph_subtype` FROM `graph_types` WHERE `graph_subtype` LIKE ?", array("$mibname-%")) as $graph) {
$seengraphs[$graph['graph_subtype']] = true;
}
foreach ($oids as $index => $array) {
$i = 1;
foreach ($array as $oid => $val) {
$graphname = "$mibname-".$mibdef[$oid]['shortname'];
// add the graph if it's not in the database already
if ($graphs[$graphname] && !$seengraphs[$graphname]) {
// construct a graph definition based on the MIB definition
$graphdef = array();
$graphdef['graph_type'] = "device";
$graphdef['graph_subtype'] = $graphname;
$graphdef['graph_section'] = "MIB";
$graphdef['graph_descr'] = $mibdef[$oid]['description'];
$graphdef['graph_order'] = $i++;
// TODO: add colours, unit_text, and ds
// add graph to the database
dbInsert($graphdef, 'graph_types');
}
}
}
}
/*
* Save all of the measurable oids for the device in their own RRDs.
*/
function save_mibs($device, $mibname, $oids, $mibdef, &$graphs)
{
$usedoids = array();
foreach ($oids as $index => $array) {
foreach ($array as $oid => $val) {
$type = oid_rrd_type($oid, $mibdef);
if (!$type) {
continue;
}
$usedoids[$index][$oid] = $val;
rrd_create_update(
$device,
array($mibname, $mibdef[$oid]['shortname'], $index),
array("DS:".$mibdef[$oid]['dsname'].":$type"),
"N:$val"
);
}
}
tag_graphs($mibname, $usedoids, $mibdef, $graphs);
update_mib_graph_types($mibname, $usedoids, $mibdef, $graphs);
}
/*
* Take a list of MIB name => module pairs.
* Validate MIBs and poll based on the results.
*/
function poll_mibs($list, $device, &$graphs)
{
if (!is_dev_attrib_enabled($device, "poll_mib")) {
d_echo("MIB module disabled for ".$device['hostname']);
return;
}
$mibdefs = array();
foreach ($list as $name => $module) {
$translated = snmp_translate($name, $module);
if ($translated) {
$mod = $translated[0];
$nam = $translated[1];
$mibdefs[$nam] = snmp_mib_load($nam, $mod);
$oids = snmpwalk_cache_oid($device, "$mod::$nam", array(), $mod);
save_mibs($device, $nam, $oids, $mibdefs[$nam], $graphs);
}
else {
d_echo("MIB: no match for $module::$name");
}
}
}
?>
Reference in New Issue View Git Blame Copy Permalink