![[tokkee]](http://tokkee.org/images/avatar.png){kind=avatar}
index cb8b5d0098339ef9e68539bb7449b18cb7d761d9..1a168bf013961a4b3ff56062ad37aaf30889e8a3 100755 (executable)
#
# Copyright (C) 2000 Christoph Kron
# Modified 5/2002 to conform to updated Nagios Plugin Guidelines (S. Ghosh)
+# Added -x option (4/2003)
+# Added -u option (4/2003)
+# Added -M option (10/2003)
+# 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
my $PROGNAME = "check_ifstatus";
+sub print_help ();
+sub usage ();
+sub process_arguments ();
+
my $status;
-my %ifOperStatus = ('1','up',
+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 $timeout ;
my $state = "UNKNOWN";
my $answer = "";
my $snmpkey=0;
my $snmpoid=0;
my $key=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 $snmpIfAdminStatus = '1.3.6.1.2.1.2.2.1.7';
my $ifup =0 ;
my $ifdown =0;
my $ifdormant = 0;
-my $ifexclude =0 ;
+my $ifexclude = 0 ;
+my $ifunused = 0;
my $ifmessage = "";
my $snmp_version = 1;
my $ifXTable;
my $opt_h ;
my $opt_V ;
+my $opt_u;
my $opt_x ;
my %excluded ;
+my @unused_ports ;
print ("ERROR: No snmp response from $hostname (alarm timeout)\n");
exit $ERRORS{"UNKNOWN"};
};
-alarm($TIMEOUT);
-
#Option checking
-$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,
- "p=i" =>\$port, "port=i" => \$port,
- "H=s" => \$hostname, "hostname=s" => \$hostname,
- "I" => \$ifXTable, "ifmib" => \$ifXTable,
- "x:s" => \$opt_x, "exclude:s" => \$opt_x);
-
-if ($status == 0)
+$status = process_arguments();
+
+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 (defined $opt_x) {
- my @x = split(",", $opt_x);
- my $x;
- if ( @x) {
- foreach $x (@x){
- $excluded{$x} = 1;
- }
- }else{
- $excluded{23} = 1; # default PPP(23) if empty list - note (AIX seems to think PPP is 22 according to a post)
- }
- #debugging
- #foreach $x (keys %excluded)
- # { print "key = $x val = $excluded{$x}\n";}
-}
-
-if (! utils::is_hostname($hostname)){
- usage();
- exit $ERRORS{"UNKNOWN"};
-}
-
-if ( ! $snmp_version ) {
- $snmp_version =1 ;
-}else{
- 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};
- }
-}
-
-
+alarm($timeout);
push(@snmpoids,$snmpIfOperStatus);
push(@snmpoids,$snmpIfAdminStatus);
if ( ( $snmpoid =~ $snmpIfName ) && defined $ifXTable ) {
print ("$state: Device does not support ifTable - try without -I option\n");
}else{
- print ("$state: $answer for $snmpoid with snmp version $snmp_version\n");
+ print ("$state: $answer for $snmpoid with snmp version $snmp_version\n");
}
exit $ERRORS{$state};
}
$session->close;
+alarm(0);
+
foreach $key (keys %ifStatus) {
- # check only if interface is administratively up
+ # skip unused interfaces
+ if (!defined($ifStatus{$key}{'notInUse'})) {
+ # check only if interface is administratively up
if ($ifStatus{$key}{$snmpIfAdminStatus} == 1 ) {
- # check only if interface type is not listed in %excluded
-
- if (!defined $excluded{$ifStatus{$key}{$snmpIfType}} ) {
- if ($ifStatus{$key}{$snmpIfOperStatus} == 1 ) { $ifup++ ;}
- if ($ifStatus{$key}{$snmpIfOperStatus} == 2 ) {
- $ifdown++ ;
- if (defined $ifXTable) {
- $ifmessage .= sprintf("%s: down -> %s<BR>",
+ # check only if interface type is not listed in %excluded
+ if (!defined $excluded{$ifStatus{$key}{$snmpIfType}} ) {
+ if ($ifStatus{$key}{$snmpIfOperStatus} == 1 ) { $ifup++ ;}
+ if ($ifStatus{$key}{$snmpIfOperStatus} == 2 ) {
+ $ifdown++ ;
+ if (defined $ifXTable) {
+ $ifmessage .= sprintf("%s: down -> %s<BR>",
$ifStatus{$key}{$snmpIfName},
- $ifStatus{$key}{$snmpIfAlias});
- }else{
- $ifmessage .= sprintf("%s: down <BR>",
+ $ifStatus{$key}{$snmpIfAlias});
+ }else{
+ $ifmessage .= sprintf("%s: down <BR>",
$ifStatus{$key}{$snmpIfDescr});
- }
+ }
+ }
+ if ($ifStatus{$key}{$snmpIfOperStatus} == 5 ) { $ifdormant++ ;}
+ }else{
+ $ifexclude++;
}
- if ($ifStatus{$key}{$snmpIfOperStatus} == 5 ) { $ifdormant++ ;}
- }else{
- $ifexclude++;
- }
+ }
+ }else{
+ $ifunused++;
}
-
}
if ($ifdown > 0) {
$state = 'CRITICAL';
- $answer = sprintf("host '%s', interfaces up: %d, down: %d, dormant: %d, excluded: %d<BR>",
+ $answer = sprintf("host '%s', interfaces up: %d, down: %d, dormant: %d, excluded: %d, unused: %d<BR>",
$hostname,
$ifup,
$ifdown,
$ifdormant,
- $ifexclude);
+ $ifexclude,
+ $ifunused);
$answer = $answer . $ifmessage . "\n";
}
else {
$state = 'OK';
- $answer = sprintf("host '%s', interfaces up: %d, down: %d, dormant: %d, excluded: %d",
+ $answer = sprintf("host '%s', interfaces up: %d, down: %d, dormant: %d, excluded: %d, unused: %d",
$hostname,
$ifup,
$ifdown,
$ifdormant,
- $ifexclude);
+ $ifexclude,
+ $ifunused);
}
-my $perfdata = sprintf("up:%d,down:%d,dormant:%d,excluded:%d",$ifup,$ifdown,$ifdormant,$ifexclude);
+my $perfdata = sprintf("up=%d,down=%d,dormant=%d,excluded=%d,unused=%d",$ifup,$ifdown,$ifdormant,$ifexclude,$ifunused);
print ("$state: $answer |$perfdata\n");
exit $ERRORS{$state};
-sub usage {
+sub usage (){
printf "\nMissing arguments!\n";
printf "\n";
printf "check_ifstatus -C <READCOMMUNITY> -p <PORT> -H <HOSTNAME>\n";
exit $ERRORS{"UNKNOWN"};
}
-sub print_help {
+sub print_help (){
printf "check_ifstatus plugin for Nagios monitors operational \n";
- printf "status of each network interface on the target host\n";
+ printf "status of each network interface on the target host\n";
printf "\nUsage:\n";
printf " -H (--hostname) Hostname to query - (required)\n";
printf " -C (--community) SNMP read community (defaults to public,\n";
printf " used with SNMP v1 and v2c\n";
printf " -v (--snmp_version) 1 for SNMP v1 (default)\n";
printf " 2 for SNMP v2c\n";
- printf " SNMP v2c will use get_bulk for less overhead\n";
+ printf " SNMP v2c will use get_bulk for less overhead\n";
+ printf " 3 for SNMPv3 (requires -U option)";
printf " -p (--port) SNMP port (default 161)\n";
printf " -I (--ifmib) Agent supports IFMIB ifXTable. For Cisco - this will provide\n";
printf " the descriptive name. Do not use if you don't know what this is. \n";
printf " -x (--exclude) A comma separated list of ifType values that should be excluded \n";
printf " from the report (default for an empty list is PPP(23).\n";
+ printf " -u (--unused_ports) A comma separated list of ifIndex values that should be excluded \n";
+ printf " from the report (default is an empty exclusion list).\n";
printf " See the IANAifType-MIB for a list of interface types.\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 " -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";
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,
+ "p=i" =>\$port, "port=i" => \$port,
+ "H=s" => \$hostname, "hostname=s" => \$hostname,
+ "I" => \$ifXTable, "ifmib" => \$ifXTable,
+ "x:s" => \$opt_x, "exclude:s" => \$opt_x,
+ "u=s" => \$opt_u, "unused_ports=s" => \$opt_u,
+ "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'};
+ }
+
+ 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
+
+ # for snmp v1 & v2c we default to community = "public"
+
+ # Excluded interfaces types (ifType) (backup interfaces, dial-on demand interfaces, PPP interfaces
+ if (defined $opt_x) {
+ my @x = split(/,/, $opt_x);
+ if ( @x) {
+ foreach $key (@x){
+ $excluded{$key} = 1;
+ }
+ }else{
+ $excluded{23} = 1; # default PPP(23) if empty list - note (AIX seems to think PPP is 22 according to a post)
+ }
+ }
+
+ # Excluded interface ports (ifIndex) - management reasons
+ if ($opt_u) {
+ @unused_ports = split(/,/,$opt_u);
+ foreach $key (@unused_ports) {
+ $ifStatus{$key}{'notInUse'}++ ;
+ }
+ }
+
+ if (! utils::is_hostname($hostname)){
+ usage();
+ exit $ERRORS{"UNKNOWN"};
+ }
+
+ # create SNMP session handle based on options passed.
+
+ if ( ! $snmp_version ) {
+ $snmp_version =1 ;
+ }else{
+ 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,
+ -authprotocol => $authproto,
+ $auth
+ );
+ }elsif ($seclevel eq 'authPriv' ) {
+ ($session, $error) = Net::SNMP->session(
+ -hostname => $hostname,
+ -port => $port,
+ -version => $snmp_version,
+ -username => $secname,
+ -authprotocol => $authproto,
+ $auth,
+ $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};
+ }
+}
+
+return $ERRORS{"OK"};
+
+}