Code

Support for IPv6 (Merijn Evertse - 1119917)
[nagiosplug.git] / plugins-scripts / check_ifoperstatus.pl
index 46964677179939bfd5392d4678413562b61ebf7c..59356bd7a21e65b4f6b34cce9184b455c6560784 100644 (file)
@@ -2,9 +2,10 @@
 #
 # check_ifoperstatus.pl - nagios plugin 
 #
-# Copyright (C) 2000 Christoph Kron
+# Copyright (C) 2000 Christoph Kron,
 # Modified 5/2002 to conform to updated Nagios Plugin Guidelines
 # Added support for named interfaces per Valdimir Ivaschenko (S. Ghosh)
+# Added SNMPv3 support (10/2003)
 #
 # This program is free software; you can redistribute it and/or
 # modify it under the terms of the GNU General Public License
 # Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 #
 #
-# Report bugs to: ck@zet.net, nagiosplug-help@lists.sf.net
+# Report bugs to:  nagiosplug-help@lists.sourceforge.net
 #
 # 11.01.2000 Version 1.0
 # $Id$
+#
+# Patches from Guy Van Den Bergh to warn on ifadminstatus down interfaces
+# instead of critical.
+#
+# Primary MIB reference - RFC 2863
+
 
 use POSIX;
 use strict;
@@ -36,26 +43,38 @@ use Getopt::Long;
 &Getopt::Long::config('bundling');
 
 my $PROGNAME = "check_ifoperstatus";
+sub print_help ();
+sub usage ();
+sub process_arguments ();
+
+my $timeout;
 my $status;
 my %ifOperStatus =     ('1','up',
                         '2','down',
                         '3','testing',
                         '4','unknown',
                         '5','dormant',
-                        '6','notPresent');
+                        '6','notPresent',
+                        '7','lowerLayerDown');  # down due to the state of lower layer interface(s)
 
 my $state = "UNKNOWN";
 my $answer = "";
 my $snmpkey = 0;
 my $community = "public";
+my $maxmsgsize = 1472 ; # Net::SNMP default is 1472
+my ($seclevel, $authproto, $secname, $authpass, $privpass, $auth, $priv, $context);
 my $port = 161;
 my @snmpoids;
-my $snmpIfDescr = '1.3.6.1.2.1.2.2.1.2';
+my $sysUptime        = '1.3.6.1.2.1.1.3.0';
+my $snmpIfDescr      = '1.3.6.1.2.1.2.2.1.2';
+my $snmpIfAdminStatus = '1.3.6.1.2.1.2.2.1.7';
 my $snmpIfOperStatus = '1.3.6.1.2.1.2.2.1.8';
-my $snmpIfName = '1.3.6.1.2.1.31.1.1.1.1';
-my $snmpIfAlias = '1.3.6.1.2.1.31.1.1.1.18';
-my $snmpLocIfDescr = '1.3.6.1.4.1.9.2.2.1.1.28';
+my $snmpIfName       = '1.3.6.1.2.1.31.1.1.1.1';
+my $snmpIfLastChange = '1.3.6.1.2.1.2.2.1.9';
+my $snmpIfAlias      = '1.3.6.1.2.1.31.1.1.1.18';
+my $snmpLocIfDescr   = '1.3.6.1.4.1.9.2.2.1.1.28';
 my $hostname;
+my $ifName;
 my $session;
 my $error;
 my $response;
@@ -65,7 +84,14 @@ my $opt_h ;
 my $opt_V ;
 my $ifdescr;
 my $key;
+my $lastc;
+my $dormantWarn;
+my $adminWarn;
+my $name;
+
+### Validate Arguments
 
+$status = process_arguments();
 
 
 # Just in case of problems, let's not hang Nagios
@@ -73,67 +99,11 @@ $SIG{'ALRM'} = sub {
      print ("ERROR: No snmp response from $hostname (alarm)\n");
      exit $ERRORS{"UNKNOWN"};
 };
-#alarm($TIMEOUT);
-
-
-$status = GetOptions(
-                       "V"   => \$opt_V, "version"    => \$opt_V,
-                       "h"   => \$opt_h, "help"       => \$opt_h,
-                       "v=i" => \$snmp_version, "snmp_version=i"  => \$snmp_version,
-                       "C=s" =>\$community, "community=s" => \$community,
-                       "k=i" =>\$snmpkey, "key=i",\$snmpkey,
-                       "d=s" =>\$ifdescr, "descr=s" => \$ifdescr,
-                       "p=i" =>\$port,  "port=i",\$port,
-                       "H=s" => \$hostname, "hostname=s" => \$hostname,
-                       "I"       => \$ifXTable, "ifmib" => \$ifXTable);
-
-
-                               
-if ($status == 0)
-{
-       print_help();
-       exit $ERRORS{'OK'};
-}
-  
-if ($opt_V) {
-       print_revision($PROGNAME,'$Revision$ ');
-       exit $ERRORS{'OK'};
-}
-
-if ($opt_h) {
-       print_help();
-       exit $ERRORS{'OK'};
-}
-
-if (! utils::is_hostname($hostname)){
-       usage();
-       exit $ERRORS{"UNKNOWN"};
-}
 
+alarm($timeout);
 
-if ( $snmp_version =~ /[12]/ ) {
-   ($session, $error) = Net::SNMP->session(
-               -hostname  => $hostname,
-               -community => $community,
-               -port      => $port,
-               -version        => $snmp_version
-       );
 
-       if (!defined($session)) {
-               $state='UNKNOWN';
-               $answer=$error;
-               print ("$state: $answer");
-               exit $ERRORS{$state};
-       }
-}elsif ( $snmp_version =~ /3/ ) {
-       $state='UNKNOWN';
-       print ("$state: No support for SNMP v3 yet\n");
-       exit $ERRORS{$state};
-}else{
-       $state='UNKNOWN';
-       print ("$state: No support for SNMP v$snmp_version yet\n");
-       exit $ERRORS{$state};
-}
+## map ifdescr to ifindex - should look at being able to cache this value
 
 if (defined $ifdescr) {
        # escape "/" in ifdescr - very common in the Cisco world
@@ -143,31 +113,32 @@ if (defined $ifdescr) {
                                                          # recommend use of SNMP v2 (get-bulk)
        if ($status==0) {
                $state = "UNKNOWN";
-               printf "$state: could not retrive ifIndex - $status-$snmpkey\n";
+               printf "$state: could not retrive ifdescr snmpkey - $status-$snmpkey\n";
                $session->close;
                exit $ERRORS{$state};
        }
 }
-if ( $snmpkey == 0 ) {
-       printf "ifIndex key cannot be 0\n";
-       usage();
-       exit $ERRORS{'UNKNOWN'};
-}
 
-   $snmpIfOperStatus = '1.3.6.1.2.1.2.2.1.8' . "." . $snmpkey;
-   $snmpIfDescr = '1.3.6.1.2.1.2.2.1.2' . "." . $snmpkey;
-   $snmpIfAlias = '1.3.6.1.2.1.31.1.1.1.18' . "." . $snmpkey ; 
 
+## Main function
+
+$snmpIfAdminStatus = $snmpIfAdminStatus . "." . $snmpkey;
+$snmpIfOperStatus = $snmpIfOperStatus . "." . $snmpkey;
+$snmpIfDescr = $snmpIfDescr . "." . $snmpkey;
+$snmpIfName    = $snmpIfName . "." . $snmpkey ;
+$snmpIfAlias = $snmpIfAlias . "." . $snmpkey ; 
 
+push(@snmpoids,$snmpIfAdminStatus);
 push(@snmpoids,$snmpIfOperStatus);
 push(@snmpoids,$snmpIfDescr);
+push(@snmpoids,$snmpIfName) if (defined $ifXTable) ;
 push(@snmpoids,$snmpIfAlias) if (defined $ifXTable) ;
 
    if (!defined($response = $session->get_request(@snmpoids))) {
       $answer=$session->error;
       $session->close;
-      $state = 'CRITICAL';
-      print ("$state: $answer for ifIndex $snmpkey\n");
+      $state = 'WARNING';
+      print ("$state: SNMP error: $answer\n");
       exit $ERRORS{$state};
    }
 
@@ -178,31 +149,94 @@ push(@snmpoids,$snmpIfAlias) if (defined $ifXTable) ;
       $ifOperStatus{$response->{$snmpIfOperStatus}}
    );
 
-   $session->close;
 
-   if ( $response->{$snmpIfOperStatus} == 1 ) {
-      $state = 'OK';
+   ## Check to see if ifName match is requested and it matches - exit if no match
+   ## not the interface we want to monitor
+   if ( defined $name && not ($response->{$snmpIfName} eq $name) ) {
+      $state = 'UNKNOWN';
+      $answer = "Interface name ($name) doesn't match snmp value ($response->{$snmpIfName}) (index $snmpkey)";
+      print ("$state: $answer");
+      exit $ERRORS{$state};
+   } 
+
+   ## define the interface name
+   if (defined $ifXTable) {
+     $name = $response->{$snmpIfName} ." - " .$response->{$snmpIfAlias} ; 
+   }else{
+     $name = $response->{$snmpIfDescr} ;
    }
-   else {
-       $state = 'CRITICAL';
+   
+   ## if AdminStatus is down - some one made a consious effort to change config
+   ##
+   if ( not ($response->{$snmpIfAdminStatus} == 1) ) {
+     $answer = "Interface $name (index $snmpkey) is administratively down.";
+     if ( not defined $adminWarn or $adminWarn eq "w" ) {
+        $state = 'WARNING';
+     } elsif ( $adminWarn eq "i" ) {
+        $state = 'OK';
+     } elsif ( $adminWarn eq "c" ) {
+        $state = 'CRITICAL';
+     } else { # If wrong value for -a, say warning
+        $state = 'WARNING';
+     }
+   } 
+   ## Check operational status
+   elsif ( $response->{$snmpIfOperStatus} == 2 ) {
+      $state = 'CRITICAL';
+      $answer = "Interface $name (index $snmpkey) is down.";
+   } elsif ( $response->{$snmpIfOperStatus} == 5 ) {
+      if (defined $dormantWarn ) {
+                               if ($dormantWarn eq "w") {
+                         $state = 'WARNING';
+                                 $answer = "Interface $name (index $snmpkey) is dormant.";
+                 }elsif($dormantWarn eq "c") {
+                       $state = 'CRITICAL';
+                                 $answer = "Interface $name (index $snmpkey) is dormant.";
+        }elsif($dormantWarn eq "i") {
+                         $state = 'OK';
+                               $answer = "Interface $name (index $snmpkey) is dormant.";
+        }
+                       }else{
+               # dormant interface  - but warning/critical/ignore not requested
+                  $state = 'CRITICAL';
+                  $answer = "Interface $name (index $snmpkey) is dormant.";
+                       }
+   } elsif ( $response->{$snmpIfOperStatus} == 6 ) {
+          $state = 'CRITICAL';
+          $answer = "Interface $name (index $snmpkey) notPresent - possible hotswap in progress.";
+   } elsif ( $response->{$snmpIfOperStatus} == 7 ) {
+          $state = 'CRITICAL';
+          $answer = "Interface $name (index $snmpkey) down due to lower layer being down.";
+
+   } elsif ( $response->{$snmpIfOperStatus} == 3 || $response->{$snmpIfOperStatus} == 4  ) {
+          $state = 'CRITICAL';
+          $answer = "Interface $name (index $snmpkey) down (testing/unknown).";
+
+   } else {
+      $state = 'OK';
+      $answer = "Interface $name (index $snmpkey) is up.";
    }
 
+
+
 print ("$state: $answer");
 exit $ERRORS{$state};
 
 
+### subroutines
+
 sub fetch_ifdescr {
        if (!defined ($response = $session->get_table($snmpIfDescr))) {
                $answer=$session->error;
                $session->close;
                $state = 'CRITICAL';
-               printf ("$state: $answer for $snmpIfDescr  with snmp version $snmp_version\n");
+               printf ("$state: SNMP error with snmp version $snmp_version ($answer)\n");
                $session->close;
                exit $ERRORS{$state};
        }
        
        foreach $key ( keys %{$response}) {
-               if ($response->{$key} =~ /$ifdescr/) {
+               if ($response->{$key} =~ /^$ifdescr$/) {
                        $key =~ /.*\.(\d+)$/;
                        $snmpkey = $1;
                        #print "$ifdescr = $key / $snmpkey \n";  #debug
@@ -218,7 +252,7 @@ sub fetch_ifdescr {
        return $snmpkey;
 }
 
-sub usage {
+sub usage() {
   printf "\nMissing arguments!\n";
   printf "\n";
   printf "usage: \n";
@@ -231,7 +265,7 @@ sub usage {
   exit $ERRORS{"UNKNOWN"};
 }
 
-sub print_help {
+sub print_help() {
        printf "check_ifoperstatus plugin for Nagios monitors operational \n";
        printf "status of a particular network interface on the target host\n";
        printf "\nUsage:\n";
@@ -242,14 +276,230 @@ sub print_help {
        printf "                        2 for SNMP v2c\n";
        printf "                        SNMP v2c will use get_bulk for less overhead\n";
        printf "                        if monitoring with -d\n";
-       printf "   -k (--key)        SNMP ifIndex value\n";
+       printf "   -L (--seclevel)   choice of \"noAuthNoPriv\", \"authNoPriv\", or     \"authPriv\"\n";
+       printf "   -U (--secname)    username for SNMPv3 context\n";
+       printf "   -c (--context)    SNMPv3 context name (default is empty      string)";
+       printf "   -A (--authpass)   authentication password (cleartext ascii or localized key\n";
+       printf "                     in hex with 0x prefix generated by using   \"snmpkey\" utility\n"; 
+       printf "                     auth password and authEngineID\n";
+       printf "   -a (--authproto)  Authentication protocol ( MD5 or SHA1)\n";
+       printf "   -X (--privpass)   privacy password (cleartext ascii or localized key\n";
+       printf "                     in hex with 0x prefix generated by using   \"snmpkey\" utility\n"; 
+       printf "                     privacy password and authEngineID\n";
+       printf "   -k (--key)        SNMP IfIndex value\n";
        printf "   -d (--descr)      SNMP ifDescr value\n";
        printf "   -p (--port)       SNMP port (default 161)\n";
        printf "   -I (--ifmib)      Agent supports IFMIB ifXTable.  Do not use if\n";
-       printf "                     you don't know what this is.\n";
+       printf "                     you don't know what this is. \n";
+       printf "   -n (--name)       the value should match the returned ifName\n";
+       printf "                     (Implies the use of -I)\n";
+       printf "   -w (--warn =i|w|c) ignore|warn|crit if the interface is dormant (default critical)\n";
+       printf "   -D (--admin-down =i|w|c) same for administratively down interfaces (default warning)\n";
+       printf "   -M (--maxmsgsize) Max message size - usefull only for v1 or v2c\n";
+       printf "   -t (--timeout)    seconds before the plugin times out (default=$TIMEOUT)\n";
        printf "   -V (--version)    Plugin version\n";
        printf "   -h (--help)       usage help \n\n";
        printf " -k or -d must be specified\n\n";
+       printf "Note: either -k or -d must be specified and -d is much more network \n";
+       printf "intensive.  Use it sparingly or not at all.  -n is used to match against\n";
+       printf "a much more descriptive ifName value in the IfXTable to verify that the\n";
+       printf "snmpkey has not changed to some other network interface after a reboot.\n\n";
        print_revision($PROGNAME, '$Revision$');
        
 }
+
+sub process_arguments() {
+       $status = GetOptions(
+                       "V"   => \$opt_V, "version"    => \$opt_V,
+                       "h"   => \$opt_h, "help"       => \$opt_h,
+                       "v=i" => \$snmp_version, "snmp_version=i"  => \$snmp_version,
+                       "C=s" => \$community, "community=s" => \$community,
+                       "L=s" => \$seclevel, "seclevel=s" => \$seclevel,
+                       "a=s" => \$authproto, "authproto=s" => \$authproto,
+                       "U=s" => \$secname,   "secname=s"   => \$secname,
+                       "A=s" => \$authpass,  "authpass=s"  => \$authpass,
+                       "X=s" => \$privpass,  "privpass=s"  => \$privpass,
+                       "c=s" => \$context,   "context=s"   => \$context,
+                       "k=i" => \$snmpkey, "key=i",\$snmpkey,
+                       "d=s" => \$ifdescr, "descr=s" => \$ifdescr,
+                       "l=s" => \$lastc,  "lastchange=s" => \$lastc,
+                       "p=i" => \$port,  "port=i" =>\$port,
+                       "H=s" => \$hostname, "hostname=s" => \$hostname,
+                       "I"   => \$ifXTable, "ifmib" => \$ifXTable,
+                       "n=s" => \$ifName, "name=s" => \$ifName,
+                       "w=s" => \$dormantWarn, "warn=s" => \$dormantWarn,
+                       "D=s" => \$adminWarn, "admin-down=s" => \$adminWarn,
+                       "M=i" => \$maxmsgsize, "maxmsgsize=i" => \$maxmsgsize,
+                       "t=i" => \$timeout,    "timeout=i" => \$timeout,
+                       );
+
+
+                               
+       if ($status == 0){
+               print_help();
+               exit $ERRORS{'OK'};
+       }
+  
+       if ($opt_V) {
+               print_revision($PROGNAME,'$Revision$ ');
+               exit $ERRORS{'OK'};
+       }
+
+       if ($opt_h) {
+               print_help();
+               exit $ERRORS{'OK'};
+       }
+
+       if (! utils::is_hostname($hostname)){
+               usage();
+               exit $ERRORS{"UNKNOWN"};
+       }
+
+
+       unless ($snmpkey > 0 || defined $ifdescr){
+               printf "Either a valid snmpkey key (-k) or a ifDescr (-d) must be provided)\n";
+               usage();
+               exit $ERRORS{"UNKNOWN"};
+       }
+
+
+       if (defined $name) {
+               $ifXTable=1;
+       }       
+
+       if (defined $dormantWarn) {
+               unless ($dormantWarn =~ /^(w|c|i)$/ ) {
+                       printf "Dormant alerts must be one of w|c|i \n";
+                       exit $ERRORS{'UNKNOWN'};
+               }
+       }
+       
+       unless (defined $timeout) {
+               $timeout = $TIMEOUT;
+       }
+
+       if ($snmp_version =~ /3/ ) {
+               # Must define a security level even though default is noAuthNoPriv
+               # v3 requires a security username
+               if (defined $seclevel  && defined $secname) {
+               
+                       # Must define a security level even though defualt is noAuthNoPriv
+                       unless ($seclevel eq ('noAuthNoPriv' || 'authNoPriv' || 'authPriv' ) ) {
+                               usage();
+                               exit $ERRORS{"UNKNOWN"};
+                       }
+                       
+                       # Authentication wanted
+                       if ($seclevel eq ('authNoPriv' || 'authPriv') ) {
+               
+                               unless ($authproto eq ('MD5' || 'SHA1') ) {
+                                       usage();
+                                       exit $ERRORS{"UNKNOWN"};
+                               }
+
+                               if ( !defined $authpass) {
+                                       usage();
+                                       exit $ERRORS{"UNKNOWN"};
+                               }else{
+                                       if ($authpass =~ /^0x/ ) {
+                                               $auth = "-authkey => $authpass" ;
+                                       }else{
+                                               $auth = "-authpassword => $authpass";
+                                       }
+                               }
+                                       
+                       }
+                       
+                       # Privacy (DES encryption) wanted
+                       if ($seclevel eq  'authPriv' ) {
+                               if (! defined $privpass) {
+                                       usage();
+                                       exit $ERRORS{"UNKNOWN"};
+                               }else{
+                                       if ($privpass =~ /^0x/){
+                                               $priv = "-privkey => $privpass";
+                                       }else{
+                                               $priv = "-privpassword => $privpass";
+                                       }
+                               }
+                       }
+
+                       # Context name defined or default
+
+                       unless ( defined $context) {
+                               $context = "";
+                       }
+               
+               
+               
+               }else {
+                                       usage();
+                                       exit $ERRORS{'UNKNOWN'}; ;
+               }
+       } # end snmpv3
+
+
+       if ( $snmp_version =~ /[12]/ ) {
+       ($session, $error) = Net::SNMP->session(
+                       -hostname  => $hostname,
+                       -community => $community,
+                       -port      => $port,
+                       -version        => $snmp_version,
+                       -maxmsgsize => $maxmsgsize
+               );
+
+               if (!defined($session)) {
+                       $state='UNKNOWN';
+                       $answer=$error;
+                       print ("$state: $answer");
+                       exit $ERRORS{$state};
+               }
+       
+       }elsif ( $snmp_version =~ /3/ ) {
+
+               if ($seclevel eq 'noAuthNoPriv') {
+                       ($session, $error) = Net::SNMP->session(
+                               -hostname  => $hostname,
+                               -port      => $port,
+                               -version  => $snmp_version,
+                               -username => $secname,
+                       );
+
+               }elsif ( $seclevel eq 'authNoPriv' ) {
+                       ($session, $error) = Net::SNMP->session(
+                               -hostname  => $hostname,
+                               -port      => $port,
+                               -version  => $snmp_version,
+                               -username => $secname,
+                               $auth,
+                               -authprotocol => $authproto,
+                       );      
+               }elsif ($seclevel eq 'authPriv' ) {
+                       ($session, $error) = Net::SNMP->session(
+                               -hostname  => $hostname,
+                               -port      => $port,
+                               -version  => $snmp_version,
+                               -username => $secname,
+                               $auth,
+                               -authprotocol => $authproto,
+                               $priv
+                       );
+               }
+                                       
+                                       
+               if (!defined($session)) {
+                                       $state='UNKNOWN';
+                                       $answer=$error;
+                                       print ("$state: $answer");
+                                       exit $ERRORS{$state};
+               }
+
+       }else{
+               $state='UNKNOWN';
+               print ("$state: No support for SNMP v$snmp_version yet\n");
+               exit $ERRORS{$state};
+       }
+
+}
+## End validation
+