Release v1.1.0

Merge pull request #5 from VGavara/master

CONTRIBUTING.md

@@ -17,7 +17,7 @@ If you have found a bug the best way of communicating it is by creating a new di
 So you have used the library and missed some feature that would be nice to have. In that case feel free of start a discussion in the [Ideas](https://github.com/VGavara/monitoring-plugins/discussions/categories/ideas) category. Those proposals considered as interesting will be converted into features. Finally they will be programmed to be published in a given release.
 
 ## I just have a question
-Asking questions is also a way of collaboration: some questions are the inspiration of new features that for sure improve the library. If you have a question, just ask it in the Discussions [Questions & Answers](https://github.com/VGavara/monitoring-plugins/categories/questions-answers) category.
+Asking questions is also a way of collaboration: some questions are the inspiration of new features that for sure improve the library. If you have a question, just ask it in the Discussions [Questions & Answers](https://github.com/VGavara/monitoring-plugins/discussions/categories/questions-answers) category.
 
 ## I want to work on a good first issue
 Some existing issues are labelled as "good first issue", meaning that they are a good starting point for begin collaborating in the project. If you have identified such a issue, please contact the repository owner to discuss specific details of the issue before starting coding. In case you didn't have chosen an issue, again contact the repository owner for discussing what could be a your good first issue.

README.md

@@ -1,9 +1,13 @@
-# Nagios compatible monitoring plugins
+# Nagios-compatible monitoring plugins
 ![License:](https://img.shields.io/github/license/vgavara/monitoring-plugins)
 ![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/VGavara/monitoring-plugins?include_prereleases)
 
-# Overview
-This repository contains a collection of check plugins for Nagios compatible monitoring engines as, among others, Nagios, Centreon or Icinga
+This repository contains a collection of check plugins for Nagios-compatible monitoring engines as, among others, Nagios, Centreon or Icinga
+
+The plugins are organized in these categories:
+
+- check_ups: Plugins for monitoring devices supporting the MIB UPS (RFC 1628).
+- check_cisco: Plugins for monitoring Cisco devices.
 
 # Contributions to the project
 In case you were interested in participating in this project, read [CONTRIBUTING.md](https://github.com/VGavara/monitoring-plugins/tree/stable/CONTRIBUTING.md) for further information.

src/check_cisco/check_cisco_ce_alarms/README.md

@@ -0,0 +1,21 @@
+# check_cisco_ce_alarms
+
+Checks the alarms on a CISCO-CONTENT-ENGINE-MIB compliant device.
+
+# Usage
+
+    check_cisco_ce_alarms -H <hostname>
+        [-C <SNMP Community>] [-e <SNMP Version>] [-P <SNMP port>] [-t <SNMP timeout>]
+        [-w <alarm level list> -c <alarm level list>]
+        [-V <version>]
+
+Type `check_cisco_ce_alarms --help` for getting more info.
+
+# Examples
+## check_cisco_ce_alarms -H 192.168.0.4
+If available, it displays info of the device with address 192.168.0.4 using SNMP protocol version 1 and 'public' as community (useful for checking plugin-device compatibility).
+
+## check_cisco_ce_alarms -H 192.168.0.4 -w M,N -c C
+Checks content engine alarms on host 192.168.0.4 using SNMP protocol version 1 and 'public' as community.
+
+Plugin returns CRITICAL if there is any critical (-c C) active alarm and WARNING if there's any minor (-w N) or major (-w M) active alarm.

src/check_cisco/check_cisco_ce_alarms/check_cisco_ce_alarms.pl

@@ -0,0 +1,315 @@
+#!/usr/bin/perl -w
+
+# check_cisco_ce_alarms Nagios-compatible plugin
+# Checks the alarms on a CISCO-CONTENT-ENGINE-MIB compliant device
+# Type check_cisco_ce_alarms --help for getting more info and examples.
+#
+# This check plugin is free software, and comes with ABSOLUTELY NO WARRANTY.
+# It may be used, redistributed and/or modified under the terms of the MIT
+# General Public Licence (see https://opensource.org/licenses/MIT).
+#
+# Vicente Gavara, Boreal labs
+#
+# HISTORY
+#
+# v.0.1b: Initial release.
+#
+# TODO
+#
+# Improve argument checking (warning and critical lists)
+
+# MODULE DECLARATION
+
+use strict;
+
+use Monitoring::Plugin;
+use Net::SNMP qw(SNMP_VERSION_2C);
+
+# FUNCTION DECLARATION
+
+sub CreateNagiosManager ();
+sub CheckArguments ();
+sub TestHost ();
+sub PerformCheck ();
+
+# CONSTANT DEFINITION
+
+use constant CONTENT_ENGINE_MIB           => '.1.3.6.1.4.1.9.9.178';
+use constant CEE_ALARM_CRITICAL_COUNT_OID => CONTENT_ENGINE_MIB . '.1.6.2.1.0';
+use constant CEE_ALARM_MAJOR_COUNT_OID    => CONTENT_ENGINE_MIB . '.1.6.2.2.0';
+use constant CEE_ALARM_MINOR_COUNT_OID    => CONTENT_ENGINE_MIB . '.1.6.2.3.0';
+
+use constant NAME    => 'check_cisco_ce_alarms';
+use constant VERSION => '0.1b';
+use constant USAGE => "Usage:\n"
+  . "check_cisco_ce_alarms -H <hostname>\n"
+  . "\t\t[-C <SNMP Community>] [-e <SNMP Version>] [-P <SNMP port>] [-t <SNMP timeout>]\n"
+  . "\t\t[-w <alarm level list> -c <alarm level list>]\n"
+  . "\t\t[-V <version>]\n";
+use constant BLURB =>
+"This plugin checks the alarms on a CISCO-CONTENT-ENGINE-MIB compliant device.";
+use constant LICENSE =>
+  "This check plugin is free software, and comes with ABSOLUTELY NO WARRANTY\n"
+  . "It may be used, redistributed and/or modified under the terms of the MIT\n"
+  . "General Public Licence (see https://opensource.org/licenses/MIT).\n";
+use constant EXAMPLE => "\n\n"
+  . "Examples:\n" . "\n"
+  . "check_cisco_ce_alarms -H 192.168.0.4\n" . "\n"
+  . "If available, displays info of the device with address 192.168.0.4\n"
+  . "using SNMP protocol version 1 and 'public' as community\n"
+  . "(useful for checking compatibility)\n" . "\n"
+  . "check_cisco_ce_alarms -H 192.168.0.4 -w M,N -c C\n"
+  . "Checks content engine alarms on host 192.168.0.4\n"
+  . "using SNMP protocol version 1 and 'public' as community.\n"
+  . "Plugin returns CRITICAL if there is any critical (c) active alarm\n"
+  . "and WARNING if there's any minor (n) or major (m) active alarm.\n"
+  . "In other case it returns OK if check has been performed or UNKNOWN";
+
+# VARIABLE DEFINITION
+
+my $Nagios;
+my $Error;
+my $PluginMode;
+my $PluginReturnValue, my $PluginOutput = '';
+
+# MAIN FUNCTION
+
+# Get command line arguments
+$Nagios = &CreateNagiosManager( USAGE, VERSION, BLURB, LICENSE, NAME, EXAMPLE );
+eval { $Nagios->getopts };
+
+if ( !$@ ) {
+
+    # Command line parsed
+    if ( &CheckArguments( $Nagios, $Error, $PluginMode ) ) {
+
+        # Argument checking passed
+        $PluginReturnValue = &PerformCheck( $Nagios, $PluginOutput );
+    }
+    else {
+        # Error checking arguments
+        $PluginOutput      = $Error;
+        $PluginReturnValue = UNKNOWN;
+    }
+    $Nagios->nagios_exit( $PluginReturnValue, $PluginOutput );
+}
+else {
+    # Error parsing command line
+    $Nagios->nagios_exit( UNKNOWN, $@ );
+}
+
+# FUNCTION DEFINITIONS
+
+# Creates and configures a Nagios plugin object
+# Input: strings (usage, version, blurb, license, name and example) to configure argument parsing functionality
+# Return value: reference to a Nagios plugin object
+
+sub CreateNagiosManager() {
+
+    # Create GetOpt object
+    my $Nagios = Monitoring::Plugin->new(
+        usage   => $_[0],
+        version => $_[1],
+        blurb   => $_[2],
+        license => $_[3],
+        plugin  => $_[4],
+        extra   => $_[5]
+    );
+
+    # Add argument hostname
+    $Nagios->add_arg(
+        spec     => 'hostname|H=s',
+        help     => 'SNMP agent hostname or IP address',
+        required => 1
+    );
+
+    # Add argument community
+    $Nagios->add_arg(
+        spec     => 'community|C=s',
+        help     => 'SNMP agent community (default: public)',
+        default  => 'public',
+        required => 0
+    );
+
+    # Add argument version
+    $Nagios->add_arg(
+        spec     => 'snmpver|e=s',
+        help     => 'SNMP protocol version (default: 1)',
+        default  => '1',
+        required => 0
+    );
+
+    # Add argument port
+    $Nagios->add_arg(
+        spec     => 'port|P=i',
+        help     => 'SNMP agent port (default: 161)',
+        default  => 161,
+        required => 0
+    );
+
+    # Add argument warning
+    $Nagios->add_arg(
+        spec => 'warning|w=s',
+        help => "Comma separated alarm criticity identifiers list. "
+          . "Valid criticity identifiers are C (critical), M (major) and N (minor)",
+        required => 0
+    );
+
+    # Add argument critical
+    $Nagios->add_arg(
+        spec => 'critical|c=s',
+        help => "Comma separated alarm criticity identifiers list. "
+          . "Valid criticity identifiers are C (critical), M (major) and N (minor)",
+        required => 0
+    );
+
+    # Return value
+    return $Nagios;
+}
+
+# Checks argument values and sets some default values
+# Input: Nagios-compatible plugin object
+# Output: Error description string, Plugin mode
+# Return value: True if arguments ok, false if not
+
+sub CheckArguments() {
+    my $Nagios = $_[0];
+
+    # Check if agent port number is > 0
+    if ( $Nagios->opts->port <= 0 ) {
+        $_[1] = "Invalid SNMP agent port: must be greater than zero";
+        return 0;
+    }
+
+    # Check warning value list
+    if ( defined( $Nagios->opts->warning )
+        && ( $Nagios->opts->warning !~ /^([CMN],)*[CMN]$/ ) )
+    {
+        $_[1] =
+"Invalid warning list: must be a comma separated alarm criticity id (C, M or N) list";
+        return 0;
+    }
+
+    # Check critical value list
+    if ( defined( $Nagios->opts->critical )
+        && ( $Nagios->opts->critical !~ /^([CMN],)*[CMN]$/ ) )
+    {
+        $_[1] =
+"Invalid critical threshold list: must be a comma separated alarm criticity id (C, M or N) list";
+        return 0;
+    }
+
+    return 1;
+}
+
+# Performs whole check:
+# Input: Nagios-compatible plugin object
+# Output: Plugin output string
+# Return value: Plugin return value
+
+sub PerformCheck() {
+    my $Nagios = $_[0];
+
+    my $SNMPSession;
+    my $SNMPError;
+    my $RequestResult;
+    my $PluginOutput      = '';
+    my $PluginReturnValue = UNKNOWN;
+
+    # Start new SNMP session
+    ( $SNMPSession, $SNMPError ) = Net::SNMP->session(
+        -hostname  => $Nagios->opts->hostname,
+        -community => $Nagios->opts->community,
+        -version   => $Nagios->opts->snmpver,
+        -port      => $Nagios->opts->port,
+        -timeout   => $Nagios->opts->timeout
+    );
+    if ( defined $SNMPSession ) {
+        $RequestResult = $SNMPSession->get_request(
+            -varbindlist => [
+                CEE_ALARM_CRITICAL_COUNT_OID, CEE_ALARM_MAJOR_COUNT_OID,
+                CEE_ALARM_MINOR_COUNT_OID
+            ]
+        );
+
+        if ($RequestResult) {
+
+            # Data successfully retrieved. Check if exists active alarms
+            if ( $RequestResult->{&CEE_ALARM_CRITICAL_COUNT_OID} > 0 ) {
+                $PluginOutput =
+"Critical active alarms: $RequestResult->{&CEE_ALARM_CRITICAL_COUNT_OID}";
+            }
+            if ( $RequestResult->{&CEE_ALARM_MAJOR_COUNT_OID} > 0 ) {
+                $PluginOutput .= ', ' if $PluginOutput ne '';
+                $PluginOutput .=
+"Major active alarms: $RequestResult->{&CEE_ALARM_MAJOR_COUNT_OID}";
+            }
+            if ( $RequestResult->{&CEE_ALARM_MINOR_COUNT_OID} > 0 ) {
+                $PluginOutput .= ', ' if $PluginOutput ne '';
+                $PluginOutput .=
+"Minor active alarms: $RequestResult->{&CEE_ALARM_MINOR_COUNT_OID}";
+            }
+
+            if ( $PluginOutput eq '' ) {
+
+                # No active alarms present
+                $PluginOutput      = 'No active alarms';
+                $PluginReturnValue = OK;
+            }
+            else {
+                # Active alarms present
+                if ( defined $Nagios->opts->critical ) {
+
+                    # Check if critical condition is fetch
+                    if (
+                        (
+                            $RequestResult->{&CEE_ALARM_CRITICAL_COUNT_OID} > 0
+                            && $Nagios->opts->critical =~ /C/
+                        )
+                        || (   $RequestResult->{&CEE_ALARM_MAJOR_COUNT_OID} > 0
+                            && $Nagios->opts->critical =~ /M/ )
+                        || (   $RequestResult->{&CEE_ALARM_MINOR_COUNT_OID} > 0
+                            && $Nagios->opts->critical =~ /N/ )
+                      )
+                    {
+                        $PluginReturnValue = CRITICAL;
+                    }
+                }
+                if ( $PluginReturnValue == UNKNOWN
+                    && defined $Nagios->opts->warning )
+                {
+              # No critical condition fetch, check if warning condition is fetch
+                    if (
+                        (
+                            $RequestResult->{&CEE_ALARM_CRITICAL_COUNT_OID} > 0
+                            && $Nagios->opts->warning =~ /C/
+                        )
+                        || (   $RequestResult->{&CEE_ALARM_MAJOR_COUNT_OID} > 0
+                            && $Nagios->opts->warning =~ /M/ )
+                        || (   $RequestResult->{&CEE_ALARM_MINOR_COUNT_OID} > 0
+                            && $Nagios->opts->warning =~ /N/ )
+                      )
+                    {
+                        $PluginReturnValue = WARNING;
+                    }
+                }
+                if ( $PluginReturnValue == UNKNOWN ) {
+
+                    # Neither critical nor warning conditions fetch
+                    $PluginReturnValue = OK;
+                }
+            }
+        }
+        else {
+            $PluginOutput = 'Error recovering content engine alarm counters';
+        }
+    }
+    else {
+        # Error starting SNMP session;
+        $PluginOutput = "Error '$SNMPError' starting session";
+    }
+
+    #Return result
+    $_[1] = $PluginOutput;
+    return $PluginReturnValue;
+}

src/check_cisco/check_cisco_cpu/README.md

@@ -0,0 +1,21 @@
+# check_cisco_cpu
+Checks the CPU load (in percent) on a CISCO-PROCESS-MIB or OLD-CISCO-CPU-MIB SNMP compliant device.
+
+# Usage
+    check_cisco_cpu -H <hostname> -r <Resource id> [-i <interval>] [-d] -w <warning value> -c <critical value>
+        [-C <SNMP Community>] [-e <SNMP Version>] [-P <SNMP port>] [-t <SNMP timeout>]
+        [-U <SNMP authentication user> -a <SNMP authentication protocol> -A <SNMP authentication pass phrase>
+        [-x <SNMP privacy protocol> -X <SNMP privacy pass phrase>] ]
+
+Type `check_cisco_cpu --help` for getting more info.
+
+# Examples
+## check_cisco_cpu -H 192.168.0.1 -r 1 -i 1m -w 80 -c 95
+Checks the last minute (-i 1m) CPU load on a CPU module with id 1 (-r 1) in a CISCO-PROCESS-MIB SNMP compliant device using 'public' as default SNPM community string and default SNMP port 161.
+
+Plugin returns WARNING if last minute CPU load is above 80%, or CRITICAL if last minute CPU load is above 95%. 
+
+## check_cisco_cpu -H 192.168.0.1 -E 3 -U admin -a MD5 -A authpass -x DES -X encryptpass -i 5m -w 85 -c 95
+Checks the last five minutes (-i 1m) CPU load on a OLD-CISCO-CPU-MIB SNMP compliant device using SNMP v3 with default port 161, authentication user 'admin', authentication protocol 'MD5', authenticacion pass phrase 'authpass', encryption protocol DES and encryption pass phrase 'encryptpass'.
+
+Plugin returns WARNING if last five minutes CPU load is above 85%,or CRITICAL if last five minutes CPU load is above 95%.