Julien Piperault Weblog

Bonsoir,

Cette semaine, j’ai dû développer un plugin Nagios pour un client afin de remonter des informations sur sa salle serveur (Température allée chaud, détection d’eau etc..).
Pour cela j’ai dû effectuer des requêtes SNMP via le langage de scripting PERL.

Dans ce billet, nous allons faire des requêtes SNMP afin de savoir si une interface d’un Switch est UP ou DOWN. J’utiliserais la MIB d’un Switch NORTEL pour l’exemple.

Le script que je vais vous présenter est très orienté Nagios (notamment pour les exit codes), mais vous pouvez vous en servir autrement.

Aller c’est parti.

Dans un premier temps nous allons faire la requête avec l’utilitaire SNMPWALK (je pars du principe que vous êtes sous Linux et que vous disposé cette utilitaire) afin de savoir si l’interface est UP ou DOWN.

La requête ci-dessous affichera la liste des ports et le status de chacun.

SUPERVISION:~# snmpwalk -v1 -c public 192.168.1.1 .1.3.6.1.2.1.2.2.1.8

Ce qui nous retourne :

THALLIUM:~# snmpwalk -v1 -c public 10.25.8.10 .1.3.6.1.2.1.2.2.1.8
RFC1213-MIB::ifOperStatus.1 = INTEGER: up(1)
RFC1213-MIB::ifOperStatus.2 = INTEGER: up(1)
RFC1213-MIB::ifOperStatus.3 = INTEGER: down(2)
RFC1213-MIB::ifOperStatus.4 = INTEGER: down(2)
RFC1213-MIB::ifOperStatus.5 = INTEGER: up(1)
RFC1213-MIB::ifOperStatus.6 = INTEGER: up(1)
RFC1213-MIB::ifOperStatus.7 = INTEGER: up(1)
RFC1213-MIB::ifOperStatus.8 = INTEGER: up(1)
RFC1213-MIB::ifOperStatus.9 = INTEGER: up(1)
…
…
…

Nous pouvons constater que le code de sortie 1 signifie que l’interface est UP et le code de sortie 2 signifie que l’interface est DOWN.

Maintenant que nous avons cette information, nous pouvons passer au développement du script PERL.

Ouvrez un fichier « .pl » :

nano check_nortel_interfaces.pl

En début de fichier, il faut mettre le Shebang :

#!/usr/bin/perl -w

Puis ont lui précise les lib que nous allons utiliser :

use strict;
use SNMP;
use Net::SNMP;
use Getopt::Long;

use strict : nous utiliserons la programmation strict.
use SNMP : nous utiliserons la lib SNMP
use Net::SNMP : cela nous permettra d’effectuer les requetes
use Getopt::Long : Cette lib permet de déclarer les options à passer en paramètres à l’exécution du script (hostname, communauté SNMP et pourquoi pas le numéro de l’interface …)

On déclare les variables :

my $oid = « .1.3.6.1.2.1.2.2.1.8. »;
my $hostname = «  »;
my $community = «  »;
my $port = «  »;
my $help = «  »;

$oid = permet de stocker l’OID qui affiche l’état de tous les ports
$hostname = permettra de stocker l’adresse IP que vous passerez en arguments à votre script
$community = permettra de stocker la communauté SNMP que vous passerez en argument à votre script
$port = permettra de choisir le port dont vous voulez savoir l’état.
$help = permettra d’afficher l’aide de votre script

Maintenant passons à la définition des arguments possible pour votre script :

Getopt::Long::Configure(‘bundling’);
GetOptions(« H=s » => \$hostname, « hostname=s » => \$hostname,
« C=s » => \$community, « community=s » => \$community,
« i=s » => \$port, « port=s » => \$port,
« h=s » => \$help, « help=s » => \$help);

Getopt existe sous plusieurs forme (Getopt::Std par exemple). Personnellement, je préfère utilisé le « Long » car il prend en charge la case.

Voici les options implémentées dans notre script d’exemple :

-H : définition de l’équipement
-C : définition de la communauté
-i : définition du port sur le switch
-h : affiche l’aide

Dans notre exemple Getopt::Std aurait suffit, mais généralement dans les plugins Nagios nous avons l’argument -C pour la communauté et -c pour la valeur critique.

On défini l’aide du script :

if($help){
print « ****************************************************\n »;
print « *\n »;
print « * Filename : check_nortel_interfaces.pl\n »;
print « *\n »;
print « ****************************************************\n »;
print « * Usage :\n »;
print « *\n »;
print « * -H Hostname to query (required)\n »;
print « * -C SNMP read community (Default : public)\n »;
print « * -i Interface port\n »;
print « * -h Help screen\n »;
print « ****************************************************\n »;
print « * Julien PIPERAULT – 2012 – Licence GPL\n »;
print « ****************************************************\n »;
}

Dorénavant lorsque dans un terminal vous taperez :

./check_nortal_interfaces.pl -h

L’aide du plugin s’affichera à l’écran.

Passons a la requête SNMP

Dans un premier temps, nous allons déclarer notre session:

my ($session, $error) = Net::SNMP->session(
-hostname => $hostname,
-community => $community,
);

Puis, nous devons récupérer le numéro de port passer en argument :

my $check_port = $oid . $port;

On concatène les variables $oid et $port afin d’avoir l’OID correspondant au port voulu.

Et on lance la requête :

my $result = $session->get_request(-varbindlist => [ $check_port ],);

Il nous reste plus qu’a exploiter la valeur de retour de la requête :

if (!defined $result) {
printf « ERROR: %s.\n », $session->error();
$session->close();
exit 3;
}
if($result->{$port} == « 1″)
{
print « L\’interface  » . $port .  » est active\n »;
$session->close();
exit 0;
}
else
{
print « L\’interface  » . $port .  » est inactive\n »;
$session->close();
exit 2;
}

Vous avez surement remarqué les exit codes. Il s’agit des codes de retour utilisé par Nagios.

Pour rappel :

0 OK (tout va bien)
1 WARNING (le seuil d’alerte est dépassé)
2 CRITICAL (le service a un problème)
3 UNKNOWN (impossible de connaître l’état du service)

L’affichage des parties de codes sur le blog étant pas top, vous pouvez télécharger le script complet : check_nortel_interfaces.1.0.tar.gz

Le script n’est pas parfait, si vous trouvez des erreurs ou faites des modifications cela m’intéresse.

Voila c’est tout pour aujourd’hui.
Bonne soirée
Julien