Snimpy : SNMP & Python

Vincent Bernat

Sou­vent consi­déré comme désuet, SNMP est tou­jours om­ni­pré­sent pour in­ter­agir avec des équi­pe­ments ré­seau. Pour la su­per­vi­sion, il per­met d’ex­po­ser di­verses mé­triques telles que les comp­teurs liés aux in­ter­faces ré­seau. Il per­met éga­le­ment d’in­ter­agir sur la confi­gu­ra­tion des équi­pements.

Les va­riables ex­po­sées par les agents SNMP (ser­veurs) sont conte­nues dans une base hié­rar­chique ap­pe­lée Ma­na­ge­ment In­for­ma­tion Base (ou MIB1). Chaque en­trée est iden­ti­fiée par un OID. En in­ter­ro­geant un OID spé­ci­fique, un ma­na­ger (client) ob­tient la va­leur as­so­ciée à la variable.

Par exemple, IF-MIB est une MIB pré­sen­tée dans la RFC 2863. Elle contient les ob­jets uti­li­sés pour gé­rer les in­ter­faces ré­seau. L’un d’eux est ifTable dont chaque ligne re­pré­sente une in­ter­face ré­seau lo­gique : son nom, ses ca­rac­té­ris­tiques et di­vers compteurs.

ifIndex ifDescr ifPhysAddress ifOperStatus ifOutOctets
1 lo up 545721741
2 eth0 0:18:f3:3:4e:4 up 78875421
3 eth1 0:18:f3:3:4e:5 down 0

ifTable est in­dexée par sa pre­mière co­lonne, ifIndex. Pour ob­te­nir le sta­tut opé­ra­tion­nel de la se­conde in­ter­face, il suf­fit d’in­ter­ro­ger IF-MIB::​ifOperStatus.2 que l’on peut tra­duire vers l’OID .1.3.6.1.2.1.2.2.1.8.2 à l’aide des in­for­ma­tions conte­nues dans la dé­fi­ni­tion de la MIB.

Automatiser SNMP#

Un agent SNMP peut four­nir de nom­breuses in­for­ma­tions in­té­ressantes :

  • les comp­teurs des in­ter­faces ré­seau via l’IF-MIB ;
  • les adresses IP via l’IP-MIB ;
  • les tables de rou­tage via l’IP-FORWARD-MIB ;
  • l’in­ven­taire phy­sique via l’ENTITY-MIB ;
  • les voi­sins via la LLDP-MIB.

Des ou­tils tels que snmpget et snmpwalk per­mettent de col­lec­ter ma­nuel­le­ment ces in­for­mations :

$ snmpwalk -v 2c -c public localhost IF-MIB::ifDescr
IF-MIB::ifDescr.1 = STRING: lo
IF-MIB::ifDescr.2 = STRING: eth0
IF-MIB::ifDescr.3 = STRING: eth1

Tou­te­fois, il est as­sez fas­ti­dieux de construire des scripts ro­bustes à l’aide de ceux-ci. Par exemple, voici un script pour ob­te­nir les des­crip­tions de toutes les in­ter­faces ré­seau ac­tives ainsi que le nombre to­tal d’oc­tets transmis :

#!/bin/sh

set -e

host="${1:-localhost}"
community="${2:-public}"
args="-v2c -c $community $host"

for idx in $(snmpwalk -Ov -OQ $args IF-MIB::ifIndex); do
    descr=$(snmpget -Ov -OQ $args IF-MIB::ifDescr.$idx)
    oper=$(snmpget -Ov -OQ $args IF-MIB::ifOperStatus.$idx)
    in=$(snmpget -Ov -OQ $args IF-MIB::ifInOctets.$idx)
    out=$(snmpget -Ov -OQ $args IF-MIB::ifOutOctets.$idx)
    [ x"$descr" != x"lo" ] || continue
    [ x"$oper" = x"up" ] || continue
    echo $descr $in $out
done

Heu­reu­se­ment, il existe des ex­ten­sions SNMP pour la plu­part des lan­gages. À titre d’exemple, voici com­ment pour­rait être ré­écrit le script ci-des­sus en ex­ploi­tant l’ex­ten­sion SNMP pour Py­thon li­vrée avec Net-⁠SNMP :

import argparse
import netsnmp

parser = argparse.ArgumentParser()
parser.add_argument(
    "host", default="localhost", nargs="?",
    help="Agent to retrieve variables from")
parser.add_argument(
    "community", default="public", nargs="?",
    help="Community to query the agent")
options = parser.parse_args()
args = {
    "Version": 2,
    "DestHost": options.host,
    "Community": options.community
}

for idx in netsnmp.snmpwalk(netsnmp.Varbind("IF-MIB::ifIndex"),
                            **args):
    descr, oper, cin, cout = netsnmp.snmpget(
        netsnmp.Varbind("IF-MIB::ifDescr", idx),
        netsnmp.Varbind("IF-MIB::ifOperStatus", idx),
        netsnmp.Varbind("IF-MIB::ifInOctets", idx),
        netsnmp.Varbind("IF-MIB::ifOutOctets", idx),
        **args)
    assert(descr is not None and
           cin is not None and
           cout is not None) # ❶
    if descr == "lo":
        continue
    if oper != "1": # ❷
        continue
    print("{} {} {}".format(descr, cin, cout))

Cette ex­ten­sion a plu­sieurs dé­fauts im­portants :

  1. Tout est pré­senté sous forme de chaînes de ca­rac­tères comme on peut le voir en ❷.
  2. La ges­tion des er­reurs est in­exis­tante. En cas d’er­reur sur le nom d’une va­riable, le mes­sage snmp_​build: unknown failure s’af­fiche mais au­cune ex­cep­tion n’est le­vée. Si une va­riable n’existe pas, les fonc­tions re­tournent None. Voir en ❶.

L’im­pos­si­bi­lité de gé­rer les er­reurs rend cette ex­ten­sion dan­ge­reuse. On ne peut ima­gi­ner ef­fec­tuer des mo­di­fi­ca­tions im­por­tantes sur la base des ré­ponses re­tour­nées. Une vé­ri­fi­ca­tion ou­bliée et un script peut en­chaî­ner des ac­tions in­ap­propriées !

Snimpy#

N’ayant pas trouvé d’ex­ten­sion fiable pour Py­thon, j’ai donc dé­cidé d’écrire Snimpy avec deux prin­ci­paux ob­jectifs :

  1. S’ap­puyer sur les in­for­ma­tions conte­nues dans les MIB pour four­nir une in­ter­face py­thonique.
  2. Toute er­reur doit se tra­duire en une ex­ception.

Voici com­ment le pré­cé­dent script pour­rait être réécrit :

#!/usr/bin/env snimpy

import argparse

parser = argparse.ArgumentParser()
parser.add_argument(
    "host", default="localhost", nargs="?",
    help="Agent to retrieve variables from")
parser.add_argument(
    "community", default="public", nargs="?",
    help="Community to query the agent")
options = parser.parse_args()

m = M(options.host, options.community, 2)

load("IF-MIB")
for idx in m.ifDescr:
    if m.ifDescr[idx] == "lo":
        continue
    if m.ifOperStatus[idx] != "up":
        continue
    print("{} {} {}".format(m.ifDescr[idx],
                            m.ifInOctets[idx],
                            m.ifOutOctets[idx]))

Une al­ter­na­tive est d’uti­li­ser les listes en com­pré­hension :

load("IF-MIB")
print("\n".join([
    "{} {} {}".format(
        m.ifDescr[idx],
        m.ifInOctets[idx],
        m.ifOutOctets[idx])
    for idx in m.ifDescr
    if m.ifDescr[idx] != "lo"
    and m.ifOperStatus[idx] == "up" ]))

Voici un autre exemple pour ob­te­nir la table de rou­tage de l’agent :

load("IP-FORWARD-MIB")
m=M("localhost", "public", 2)
routes = m.ipCidrRouteNextHop
for x in routes:
    net, netmask, tos, src = x
    print("{:>15s}/{:<15s} via {:<15s} src {:<15s}".format(
        net, netmask, routes[x], src))

IP-FORWARD-MIB::​ipCidrRouteNextHop est is­sue d’une table uti­li­sant un in­dex com­posé. Ce­pen­dant, son uti­li­sa­tion semble tou­jours na­turelle.

Tech­ni­que­ment, les re­quêtes SNMP sont gé­rées par PySNMP et les MIB sont in­ter­pré­tées à l’aide de libsmi2. Snimpy fonc­tionne à la fois avec Py­thon 2 et Py­thon 3. Pour plus d’in­for­ma­tions, je­tez un œil sur la do­cu­men­ta­tion de Snimpy.