librenms/includes/snmp.inc.php

<?php

#-r RETRIES            set the number of retries
#-t TIMEOUT            set the request timeout (in seconds)

#$config['snmp']['timeout'] = 300; # timeout in ms
#$config['snmp']['retries'] = 6; # how many times to retry the query
    
function snmp_get ($device, $oid, $options = NULL, $mib = NULL, $mibdir = NULL) 
{
  global $debug; global $config; global $runtime_stats;
  $cmd  = $config['snmpget'] . " -" . $device['snmpver'] . " -c " . $device['community'] . " " . $device['hostname'].":".$device['port'];
  if($options) { $cmd .= " " . $options; }
  if($mib) { $cmd .= " -m " . $mib; }
  if($mibdir) { $cmd .= " -M " . $mibdir; } else { $cmd .= " -M ".$config['mibdir']; }
  $cmd .= " -t " . $config['snmp']['timeout'] . " -r " . $config['snmp']['retries'];
  $cmd .= " ".$oid;
  if($debug) { echo("$cmd\n"); }
  $data = trim(shell_exec($cmd));
  $runtime_stats['snmpget']++;
  if($debug) { echo("$data\n"); }
  if (is_string($data) && (preg_match("/No Such (Object|Instance)/i", $data) || preg_match("/No more variables left/i", $data)))
  { $data = false; } else { return $data; }
}

function snmp_walk($device, $oid, $options = NULL, $mib = NULL, $mibdir = NULL) 
{
  global $debug; global $config; global $runtime_stats;
  if ($device['snmpver'] == 'v1' || $config['os'][$device['os']]['nobulk'])
  { 
    $snmpcommand = $config['snmpwalk'];
  }
  else
  {
    $snmpcommand = $config['snmpbulkwalk'];
  }
  $cmd  = $snmpcommand . " -" . $device['snmpver'] . " -c " . $device['community'] . " " . $device['hostname'].":".$device['port'];
  if($options) { $cmd .= " $options "; }
  if($mib) { $cmd .= " -m $mib"; }
  if($mibdir) { $cmd .= " -M " . $mibdir; } else { $cmd .= " -M ".$config['mibdir']; }
  $cmd .= " -t " . $config['snmp']['timeout'] . " -r " . $config['snmp']['retries'];
  $cmd .= " ".$oid;
  if($debug) { echo("$cmd\n"); }
  $data = trim(shell_exec($cmd));
  $runtime_stats['snmpwalk']++;
  if($debug) { echo("$data\n"); }
  if (is_string($data) && (preg_match("/No Such (Object|Instance)/i", $data) || preg_match("/No more variables left/i", $data)))
  { $data = false; } else { return $data; }
}

function snmp_cache_cip($oid, $device, $array, $mib = 0) 
{
  global $config;
  if ($device['snmpver'] == 'v1' || $config['os'][$device['os']]['nobulk'])
  { 
    $snmpcommand = $config['snmpwalk'];
  }
  else
  {
    $snmpcommand = $config['snmpbulkwalk'];
  }
  $cmd  = $snmpcommand . " -O snQ -" . $device['snmpver'] . " -c " . $device['community'] . " " . $device['hostname'].":".$device['port'];
  if($mib) { $cmd .= " -m $mib"; }
  $cmd .= " -M ".$config['install_dir']."/mibs/";
  $cmd .= " -t " . $config['snmp']['timeout'] . " -r " . $config['snmp']['retries'];
  $cmd .= " ".$oid;
  $data = trim(shell_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[$device_id][$ifIndex][$mac][$oid][$dir] = $this_value;
    }
  }
  return $array;
}

function snmp_cache_ifIndex($device) {
  global $config;
  if ($device['snmpver'] == 'v1' || $config['os'][$device['os']]['nobulk'])
  { 
    $snmpcommand = $config['snmpwalk'];
  }
  else
  {
    $snmpcommand = $config['snmpbulkwalk'];
  }
  $cmd  = $snmpcommand . " -O Qs -" . $device['snmpver'] . " -c " . $device['community'] . " " . $device['hostname'].":".$device['port'];
  $cmd .= " -M ".$config['install_dir']."/mibs/";
  $cmd .= " -m IF-MIB ifIndex";  
  $cmd .= " -t " . $config['snmp']['timeout'] . " -r " . $config['snmp']['retries'];
  $data = trim(shell_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);
    $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($poll_oid, $device, $array, $mib = NULL, $mibdir = NULL) {
  global $config; global $debug;
  $data = snmp_walk($device, $poll_oid, "-OQUs", $mib, $mibdir);
  $device_id = $device['device_id'];
  foreach(explode("\n", $data) as $entry) {
    list($oid,$value) = explode("=", $entry);
    $oid = trim($oid); $value = trim($value);
    list($oid, $index) = explode(".", $oid);
    if (!strstr($value, "at this OID") && isset($oid) && isset($index)) {
      $array[$device_id][$index][$oid] = $value;
    }
  }
  return $array;
}

function snmpwalk_cache_multi_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);
    $oid = trim($oid); $value = trim($value);
    $oid_parts = explode(".", $oid);
    $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($oid) && isset($index)) {
      $array[$device[device_id]][$index][$oid] = $value;
    }
  }
  return $array;
}


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);
    $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[$device[device_id]][$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);
    $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[$device[device_id]][$index][$oid] = $value;
    }
  }
  return $array;
}



function snmpwalk_cache_twopart_oid($oid, $device, $array, $mib = 0) {
  global $config;
  if ($device['snmpver'] == 'v1' || $config['os'][$device['os']]['nobulk'])
  { 
    $snmpcommand = $config['snmpwalk'];
  }
  else
  {
    $snmpcommand = $config['snmpbulkwalk'];
  }
  $cmd  = $snmpcommand . " -O QUs -" . $device['snmpver'] . " -c " . $device['community'] . " " . $device['hostname'].":".$device['port'];
  $cmd .= " -M ".$config['install_dir']."/mibs/";
  if($mib) { $cmd .= " -m $mib"; }
  $cmd .= " -t " . $config['snmp']['timeout'] . " -r " . $config['snmp']['retries'];
  $cmd .= " ".$oid;
  $data = trim(shell_exec($cmd));
  $device_id = $device['device_id'];
  foreach(explode("\n", $data) as $entry) {
    list($oid,$value) = explode("=", $entry);
    $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[$device_id][$first][$second][$oid] = $value;
    }
  }
  return $array;
}

function snmpwalk_cache_threepart_oid($oid, $device, $array, $mib = 0) {
  global $config, $debug;
  if ($device['snmpver'] == 'v1' || $config['os'][$device['os']]['nobulk'])
  { 
    $snmpcommand = $config['snmpwalk'];
  }
  else
  {
    $snmpcommand = $config['snmpbulkwalk'];
  }
  $cmd  = $snmpcommand . " -O QUs -" . $device['snmpver'] . " -c " . $device['community'] . " " . $device['hostname'].":".$device['port'];
  $cmd .= " -M ".$config['install_dir']."/mibs/";
  if($mib) { $cmd .= " -m $mib"; }
  $cmd .= " -t " . $config['snmp']['timeout'] . " -r " . $config['snmp']['retries'];
  $cmd .= " ".$oid;
  $data = trim(shell_exec($cmd));
  $device_id = $device['device_id'];
  foreach(explode("\n", $data) as $entry) {
    list($oid,$value) = explode("=", $entry);
    $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[$device_id][$first][$second][$third][$oid] = $value;
    }
  }
  return $array;
}

function snmp_cache_slotport_oid($oid, $device, $array, $mib = 0) {
  global $config;
  if ($device['snmpver'] == 'v1' || $config['os'][$device['os']]['nobulk'])
  { 
    $snmpcommand = $config['snmpwalk'];
  }
  else
  {
    $snmpcommand = $config['snmpbulkwalk'];
  }
  $cmd  = $snmpcommand . " -O QUs -" . $device['snmpver'] . " -c " . $device['community'] . " " . $device['hostname'].":".$device['port'];
  if($mib) { $cmd .= " -m $mib"; }
  $cmd .= " -M ".$config['install_dir']."/mibs/";
  $cmd .= " -t " . $config['snmp']['timeout'] . " -r " . $config['snmp']['retries'];
  $cmd .= " ".$oid;
  $data = trim(shell_exec($cmd));
  $device_id = $device['device_id'];
  foreach(explode("\n", $data) as $entry) {
    $entry = str_replace($oid.".", "", $entry);
    list($slotport, $value) = explode("=", $entry);
    $slotport = trim($slotport); $value = trim($value);
    if ($array[$device_id][$slotport]['ifIndex']) {
      $ifIndex = $array[$device_id][$slotport]['ifIndex'];
      #$array[$device_id][$slotport][$oid] = $value;
      $array[$device_id][$ifIndex][$oid] = $value;
    }
  }
  return $array;
}


function snmp_cache_oid($oid, $device, $array, $mib = 0) {
  global $config;
  if ($device['snmpver'] == 'v1' || $config['os'][$device['os']]['nobulk'])
  { 
    $snmpcommand = $config['snmpwalk'];
  }
  else
  {
    $snmpcommand = $config['snmpbulkwalk'];
  }
  $cmd  = $snmpcommand . " -O UQs -" . $device['snmpver'] . " -c " . $device['community'] . " " . $device['hostname'].":".$device['port'];
  if($mib) { $cmd .= " -m $mib"; }
  $cmd .= " -M ".$config['install_dir']."/mibs/";
  $cmd .= " -t " . $config['snmp']['timeout'] . " -r " . $config['snmp']['retries'];
  $cmd .= " ".$oid;
  $data = trim(shell_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);
    list ($this_oid, $this_index) = explode(".", $this_oid);
    $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[$device_id][$this_index][$this_oid] = $this_value;
    }
    $array[$device_id][$oid] = '1';
  }
  return $array;
}

function snmp_cache_port_oids($oids, $port, $device, $array, $mib=0) {
  global $config;
  foreach($oids as $oid){
    $string .= " $oid.$port";
  }
  $cmd = $config['snmpget'] . " -O vq -" . $device['snmpver'] . " -c " . $device['community'] . " " . $device['hostname'].":".$device['port'];
  $cmd .= " -M ".$config['install_dir']."/mibs/";
  if($mib) { $cmd .= " -m $mib"; }
  $cmd .= " -t " . $config['snmp']['timeout'] . " -r " . $config['snmp']['retries'];
  $cmd .= " ".$string;
  $data = trim(shell_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[$device[device_id]][$port][$oid] = $values[$x];
    }
    $x++;
  }
  return $array;
}

function snmp_cache_portIfIndex ($device, $array) {
  global $config;
  $cmd = $config['snmpwalk'] . " -CI -m CISCO-STACK-MIB -O q -" . $device['snmpver'] . " -c " . $device['community'] . " " . $device['hostname'].":".$device['port'];
  $cmd .= " -M ".$config['install_dir']."/mibs/";
  $cmd .= " -t " . $config['snmp']['timeout'] . " -r " . $config['snmp']['retries'];
  $cmd .= " portIfIndex";
  $output = trim(shell_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);
    if($slotport && $ifIndex){
      $array[$device_id][$ifIndex]['portIfIndex'] = $slotport;
      $array[$device_id][$slotport]['ifIndex'] = $ifIndex;
    }
  }
  return $array;
}

function snmp_cache_portName ($device, $array) {
  global $config;
  $cmd = $config['snmpwalk'] . " -CI -m CISCO-STACK-MIB -O Qs -" . $device['snmpver'] . " -c " . $device['community'] . " " . $device['hostname'].":".$device['port'];
  $cmd .= " -M ".$config['install_dir']."/mibs/";
  $cmd .= " -t " . $config['snmp']['timeout'] . " -r " . $config['snmp']['retries'];
  $cmd .= " portName";
  $output = trim(shell_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);
    $slotport = trim($slotport); $portName = trim($portName);
    if ($array[$device_id][$slotport]['ifIndex']) {
      $ifIndex = $array[$device_id][$slotport]['ifIndex'];
      $array[$device_id][$slotport]['portName'] = $portName;
      $array[$device_id][$ifIndex]['portName'] = $portName;
    }
  }
  return $array;
}

?>