check_hp_procurve.pl in Aktion

Manch­mal, wenn man ein­fach nichts pas­sen­des für den eige­nen Bedarf fin­det, muss man eben selbst ran. In mei­nem Falle geht es um die Über­wa­chung mei­nes HP Pro­Curve 1810G-24 mit Icinga. Die­ser Switch ist nur rudi­men­tär ver­walt­bar, aber es las­sen sich den­noch eine Reihe an Infor­ma­tio­nen her­aus kit­zeln — sogar über SNMP.

Eines vor­weg: Natür­lich las­sen sich alle Infor­ma­tio­nen auch mit check_snmp gewin­nen, aber ich wollte gleich noch ein paar Funk­tio­nen zur Bewer­tung der Ergeb­nisse haben. Manch­mal möchte man, dass ein Port eben im Nor­mal­fall „down” ist.

So ent­stand am heu­ti­gen Nach­mit­tag ein rudi­men­tä­res Plu­gin für Icinga, das Monitoring-System, dem ich hier ein­setze. Natür­lich funk­tio­niert es auch für Nagios.

Prin­zi­pi­ell funk­tio­niert das Plu­gin wie folgt:

1. Hole die gewünschte Information
2. Ver­glei­che das Ergeb­nis mit den Vor­ga­ben für OK, WARNING und CRITICAL — diese Vor­ga­ben beste­hen aus Regu­lä­ren Aus­drü­cken (Regu­lar Expres­si­ons) und sind auch als Gan­zes negierbar.
3. Gib den ent­spre­chen­den Wert zurück

Fol­gende Tests bzw. Infor­ma­ti­ons­an­for­de­run­gen sind bereits implementiert:

• sys­Desc — Hole die System-Beschreibung (ent­hält Infor­ma­tio­nen zum Pro­dukt und zur ver­wen­de­ten Code-Version)
• sys­Up­time — Hole die System-Uptime
• sys­Name — Hole den System-Namen
• sys­Con­tact — Hole den System-Kontakt (z. B. Name des Administrators)
• sys­Lo­ca­tion — Hole den System-Standort
• port­Sta­tus — Ist der Port in Ver­wen­dung oder nicht („up” bzw. „down”)?
• por­tAd­min­Sta­tus — Ist der Port akti­viert oder deaktiviert?
• port­Speed — Mit wel­cher Geschwin­dig­keit wird gear­bei­tet (100 MBit/s, 1 GBit/s)?
• port­Type — Fast Ether­net, Giga­bit Ethernet
• port­Desc — Beschrei­bung des Ports
• port­In­Bytes — Ein­ge­gan­gene Bytes am Port
• por­tOut­Bytes — Aus­ge­gan­gene Bytes am Port
• portI­nEr­rors — Anzahl der feh­ler­haf­ten Ein­gangs­pa­kete am Port
• por­tOu­tEr­rors — Anzahl der feh­ler­haf­ten Aus­gangs­pa­kete am Port
• portMTU — MTU des Ports

Pro­bleme gibt es selbst­ver­ständ­lich auch (noch). So funk­tio­niert zum Bei­spiel noch keine Bestim­mung der ver­wen­de­ten Band­breite eines Ports. Lei­der schei­nen die dazu gehö­ri­gen Werte bei 2147483647 auf­zu­hö­ren und dann nicht mehr wei­ter zu zäh­len. Auf dem Web-Interface hin­ge­gen geht es wei­ter. Da muss ich wohl noch ein wenig Hirm­schmalz investieren.

Zum Down­load steht diese erste Ver­sion bei Sourcef­orge. Da das Plu­gin kom­plett in Perl geschrie­ben ist, ist eine ein­fa­che Anpas­sung an eigene Bedürf­nisse mög­lich und selbst­ver­ständ­lich auch im Rah­men der GPLv3 erlaubt und erwünscht.

Hier ein Aus­schnitt aus dem Hilfe-Text, der alle Kon­fi­gu­ra­ti­ons­op­tio­nen auf­lis­tet und Kon­fi­gu­ra­ti­ons­emp­feh­lun­gen gibt:

Usage:
    ./check_hp_procurve.pl
         -H <HostAddress>
         [-C <CommunityString>]
         -T <TestName>
         -o <ValueForOK>
         [-no]
         -w <ValueForWarning>
         [-nw]
         -c <ValueForCritical>
         [-nc]
         [-v]
         [-h]
         [-t <timeout_sec>]
         [-p <Port>]
         [-f <StateOnFail>]
         [-u <StateOnUnknown>]
         [-1810G]

    Parameters:
        -h                       Show help and exit with status UNKNOWN
        -H <HostAddress>         The IP address or the host name of the switch
        -C <CommunityString>     The SNMP community string (default: public) [optional]
        -T <TestName>            The Test to execute. See listing below.
        -o <ValueForOK>          Regular expression to identify a result that is considered to be OK
        -w <ValueForWarning>     Regular expression to identify a result that is considered to be a WARNING
        -c <ValueForCritical>    Regular expression to identify a result that is considered to be a CRITICAL
        -t <Timeout_Secs>        Timeout in seconds. From 1 to 60. (default: 5) [optional]
        -p <Port>                SNMP port of the switch. (default: 161) [optional]
        -f <StateOnFail>         Status (OK, WARNING, CRITICAL, UNKNOWN) to report when SNMP query failed (default: UNKNOWN) [optional]
        -u <StateOnUnknown>      Status (OK, WARNING, CRITICAL, UNKNOWN) to report when no result rule matched (default: UNKNOWN) [optional]
        -1810G                   Traffic counting for 1810G (EXPERIMENTAL) (not implemented yet)
        -v                       Verbose output

    Negation of -c -w -o:
        You might want to negate the meaning of a -c -w or -o regex, so that the condition is fulfilled when the regex
        does not match the query result.
        -no                      Negate -o regex
        -nw                      Negate -w regex
        -nc                      Negate -c regex

    Additional parameters, depending on test to execute:
        -i <InterfaceNumber>     Interface number (switch port from 1..max)

    There are following Tests (-T):
        sysDesc                  Get the switch system description
        sysUptime                Get the switch uptime
        sysName                  Get the switch system name
        sysLocation              Get the switch location
        sysContact               Get the contact name for the switch
        portStatus               Get the operative port status (up/down). Needs parameter -i.
        portAdminStatus          Get the administrative port status (up/down). Needs parameter -i.
        portSpeed                Get the Port Speed in Bits per Second. Needs parameter -i.
                                 0 = not connected, 10000000 = 10 MBit/s, 100000000 = 100 MBit/s, 1000000000 = 1000 MBit/s
        portType                 Get the Port type. Needs paramenter -i.
                                 possible return values: GigabitEthernet, FastEthernet, other or the Type ID.
        portDesc                 Port Description. Needs parameter -i.
        portInBytes              Get the incoming bytes on this port. Needs parameter -i.
        portOutBytes             Get the incoming bytes on this port. Needs parameter -i.
        portInErrors             Get number of incoming errors on this port. Needs parameter -i.
        portOutErrors            Get number of outgoing errors on this port. Needs parameter -i.
        portMTU                  Get the MTU of this port. Needs parameter -i.

    Configuration proposals:
    +-----------------------+-----------------------+-----------------------+-----------------------+-----------------------+-----------------------+
    | Test (-t)             | OK-Value (-o)         | Warning-Value (-w)    | Critical-Value (-c)   | On SNMP Fail (-f)     | On Unknown (-u)       |
    +-----------------------+-----------------------+-----------------------+-----------------------+-----------------------+-----------------------|
    | sysDesc               | <empty>               | "/^$/"                | <empty>               | CRITICAL              | OK                    |
    | sysUptime             | <empty>               | <empty>               | <empty>               | CRITICAL              | OK                    |
    | sysName               | <empty>               | "/^$/"                | <empty>               | CRITICAL              | OK                    |
    | sysLocation           | <empty>               | "/^$/"                | <empty>               | CRITICAL              | OK                    |
    | sysContact            | <empty>               | "/^$/"                | <empty>               | CRITICAL              | OK                    |
    | portStatus            | "/^UP$/"              | <empty>               | "/^DOWN$/"            | CRITICAL              | CRITICAL              |
    | portAdminStatus       | "/^UP$/"              | "/^DOWN$/"            | <empty>               | CRITICAL              | CRITICAL              |
    | portSpeed             | "/^1([0]{8,9})$/"     | "/^1([0]{7,7})$/"     | <empty>               | CRITICAL              | WARNING               |
    | portType              | <empty>               | <empty>               | <empty>               | CRITICAL              | OK                    |
    | portDesc              | <empty>               | <empty>               | <empty>               | CRITICAL              | OK                    |
    | portInBytes           | <empty>               | <empty>               | <empty>               | CRITICAL              | OK                    |
    | portOutBytes          | <empty>               | <empty>               | <empty>               | CRITICAL              | OK                    |
    | portInErrors          | <empty>               | "/^(^(0))$/" (-nw)    | <empty>               | CRITICAL              | OK                    |
    | portOutErrors         | <empty>               | "/^(^(0))$/" (-nw)    | <empty>               | CRITICAL              | OK                    |
    | portMTU               | <empty>               | <empty>               | <empty>               | CRITICAL              | OK                    |
    +-----------------------+-----------------------+-----------------------+-----------------------+-----------------------+-----------------------+

    WARNING: portInBytes, portOutBytes, portInErrors, portOutErrors seems to end at 2147483647 and stops counting there.

    Traffic measuring mode for 1810G (-1810G):
        WARNING! This is a highly experimental feature! Be advised, it deletes the switch counters!
        When -1810G is set, no other measurements or tests can be performed.
        --- The feature is not implemented yet ---

So sieht eine bei­spiel­hafte Ver­wen­dung als Nagios-/Icinga-Commands aus:

# Definitions:
#   $HOSTADDRESS$    Should be the host to check and is provided by Nagios/Icinga
#   $ARG1$           Contains the community string. In most cases, it is "public".
#   $ARG2$           Interface number
#   $ARG3$           OK Regex

# The definitions are based on the assumption, that check_hp_procurve.pl is located
# in the $USER1$ directory, next to the other Nagios plugins.

# Check if a port is up.
# returns CRITICAL on SNMP error, UNKNOWN on unknown state
# returns OK on Port Up, returns WARNING at Port Down
define command{
	command_name    check_hppc_portisup
	command_line    $USER1$/check_hp_procurve.pl -H $HOSTADDRESS$ -C $ARG1$ -T portStatus -i $ARG2$ -o "/^UP$/" -w "/^DOWN$/" -u UNKNOWN -f CRITICAL -t 5
}

# Check if a port is down.
# returns CRITICAL on SNMP error, UNKNOWN on unknown state
# returns OK on Port Down, returns CRITICAL at Port Up
define command{
	command_name    check_hppc_portisdown
	command_line    $USER1$/check_hp_procurve.pl -H $HOSTADDRESS$ -C $ARG1$ -T portStatus -i $ARG2$ -c "/^UP$/" -o "/^DOWN$/" -u UNKNOWN -f CRITICAL -t 5
}

# Check if a port is in GigaBit Mode.
# returns CRITICAL on SNMP error, UNKNOWN on unknown state
# returns OK on GigaBit, returns WARNING at 100 MBit/s, returns CRITICAL on 10 MBit/s
define command{
	command_name    check_hppc_portisgigabit
	command_line    $USER1$/check_hp_procurve.pl -H $HOSTADDRESS$ -C $ARG1$ -T portSpeed -i $ARG2$ -o "/^1([0]{9,9})$/" -w "/^1([0]{8,8})$/" -c "/^1([0]{7,7})$/" -u UNKNOWN -f CRITICAL -t 5
}

# Check if System Name is set
# returns CRITICAL on SNMP error, UNKNOWN on unknown state
# returns OK when name is set, WARNING otherwise.
define command{
	command_name    check_hppc_systemnameisset
	command_line    $USER1$/check_hp_procurve.pl -H $HOSTADDRESS$ -C $ARG1$ -T sysName -o "/^$/" -no -w "/^$/" -u UNKNOWN -f CRITICAL -t 5
}

# Check if System Location is set
# returns CRITICAL on SNMP error, UNKNOWN on unknown state
# returns OK when location is set, WARNING otherwise.
define command{
	command_name    check_hppc_systemlocationisset
	command_line    $USER1$/check_hp_procurve.pl -H $HOSTADDRESS$ -C $ARG1$ -T sysLocation -o "/^$/" -no -w "/^$/" -u UNKNOWN -f CRITICAL -t 5
}

# Check if System Contact is set
# returns CRITICAL on SNMP error, UNKNOWN on unknown state
# returns OK when contact is set, WARNING otherwise.
define command{
	command_name    check_hppc_systemcontactisset
	command_line    $USER1$/check_hp_procurve.pl -H $HOSTADDRESS$ -C $ARG1$ -T sysContact -o "/^$/" -no -w "/^$/" -u UNKNOWN -f CRITICAL -t 5
}

# Check if code version is the current one.
# returns CRITICAL on SNMP error
# returns OK when version matches (see $ARG3$, and set $ARG2$ to 0) is set, WARNING otherwise.
# Example: check_hppc_version!public!0!"/P\.1\.1\.17/i"
define command{
	command_name    check_hppc_version
	command_line    $USER1$/check_hp_procurve.pl -H $HOSTADDRESS$ -C $ARG1$ -T sysDesc -o $ARG3$ -u WARNING -f CRITICAL -t 5
}

Diese Bei­spiele für Com­mands sind selbst­ver­ständ­lich auch im Download-Paket enthalten.

Ich hoffe, dass Plu­gin hilft jeman­dem. Über kon­struk­ti­ves Feed­back freue ich mich selbstverständlich.

Die jeweils aktu­elle Ver­sion gibt es hier zum ♦ Down­load.