Aktionen

Host per Popup-Skript aus der Zabbix-Server Weboberfläche in Wartung setzen

Aus znilwiki

1 Vorwort

Nachfolgend wird beschrieben wie man direkt aus der Weboberfläche von Zabbix aus dem Submenü / Popupmenü eines Hosts diesen in den Wartungsmodus versetzt.
Das tolle daran ist das man so auch "Read-Only" Benutzern die Möglichkeit geben kann, einen Host (den er sehen kann) in den Wartungsmodus zu versetzen.



2 Benutzer für Skript anlegen

Erstellt einen neuen Superadmin Benutzer in Zabbix, das Passwort am besten nur Buchstaben und Zahlen.

Benutzer : setmaintenance
Passwort : abc123
Gruppen  : Zabbix administrators
User type: Zabbix Super Admin

Falls Ihr LDAP-Authentifizierung nutzt sollte der Benutzer in die "noLDAP" Gruppe.



3 Skript auf Zabbix Server hinterlegen

Erstellt im externalscripts Verzeichnis von Zabbix das folgende Skript:

nano /usr/lib/zabbix/externalscripts/zabbix_main_host.pl

Den genauen Pfad findet Ihr in der zabbix_server.conf

#!/usr/bin/perl

use strict;
use Getopt::Std;
use vars qw/ %opt /;

my $url = "http://localhost/api_jsonrpc.php"; # change <localhost> to your Zabbix WEB-FRONTEND Server if different!!!!
my $apiuser="setmaintenance"; # API User's Username
my $apipassword="abc123"; # API User's password
my $maintenanceid;

#############
# Begin main
#
init();
my $hostname = $opt{s};
my $duration = $opt{d} || 10800;
my $maintname = $opt{n}; 


# Authenticate against Zabbix for API Maintenance addition
my $auth = newrequest($url, $apiuser, $apipassword);
my $hostid = gethostid($hostname);

if($opt{r}){
    print "Removing maintenance for host $hostname\n";
    getmaintid($hostid,$maintname);
    exit(0);
}else{
    print "Adding maintenance for host $hostname\n";
    addmaint($hostid,$duration,$maintname);
}
exit(0);

#########################
# Get command line input
#
sub init(){
    my $opt_string = 'hrs:d:n:';
    getopts( "$opt_string", \%opt ) or usage();
    usage() if $opt{h};
    usage() if !$opt{s};
    usage() if !$opt{n};
}
#####################
# Print script usage
#
sub usage(){
    print STDERR << "EOF";
usage: $0 [-hr] -s hostname [-d duration] -n name
 -h          : This (help) message   
 -r          : Remove maintenance for specified host 
 -s hostname : Hostname in Zabbix
 -d          : Duration of maintenance in seconds. Leave blank to use default.
                 300 =  5 minutes
                1800 = 30 minutes
                3600 =  1 hour
               10800 =  3 hour (default)
 -n name     : unique identifier

-s and -n are required
 
example: $0 -s hostname -d 3600 -n backup
example: $0 -s hostname -r -n backup
EOF
    exit;
}


#############################################
# Zabbix API requests require authentication
#
sub newrequest {
    my ($url, $user, $password) = @_;
 
    my $authenticate = qq(curl -k -s -i -X POST -H 'Content-Type: application/json-rpc' -d '{
        "params": {
            "password": "$password",
            "user": "$user"
        },
        "jsonrpc": "2.0",
        "method": "user.login",
        "id": 0
    }'  $url | grep result | head -n 1 | cut -d '"' -f 8);
    my $auth = `$authenticate`;
    chomp($auth);
    return $auth

}

###################################################
# Subroutine to query Zabbix to get host id
#
sub gethostid{
    my $hostname = shift;
    my $process = qq(curl -k -s -i -X POST -H 'Content-Type: application/json-rpc' -d '{
    "params": {
        "filter": {
            "name": "$hostname"
        }
    },
    "jsonrpc": "2.0",
    "method": "host.get",
    "auth": "$auth",
    "id": 2 }' $url);
    my $res = `$process`;
    chomp($res);

    # print "$res \n\n";
    my @output = split(/,/,$res);
    my $x=0;
    foreach(@output){
    if (($output[$x] =~ m/\"host\"/)&&($output[$x] =~ m/$hostname/)){
            $output[$x-2] =~ s/\[\{//g;
            $output[$x-2] =~ s/"//g;
            $output[$x-2] =~ s/hostid://g;
            $output[$x-2] =~ s/result://g;
            $output[$x-2] =~ s/\{//g;
            $hostid = $output[$x-2];
        }
        $x++;
    }
    if(!$hostid){
       print "WARNING - $hostname not found in maintenance for Zabbix.\n";
       exit(1);
    }
    print "Host ID: ".$hostid."\n";
    return $hostid
}


###################################################
# Subroutine to query Zabbix to get maintenance id
#
sub getmaintid{
    my $hostid = shift;
    my $maintname = shift;
    my $process = qq(curl -k -s -i -X POST -H 'Content-Type: application/json-rpc' -d '{
    "params": {
        "output": "extend",
        "selectHosts": "refer",
        "selectGroups": "refer",
        "hostids": "$hostid"
    },
    "jsonrpc": "2.0",
    "method": "maintenance.get",
    "auth": "$auth",
    "id": 2 }' $url);
 
    my $res = `$process`;
    chomp($res);
 
    my @output = split(/,/,$res);
    my $x=0;
    foreach(@output){
        if (($output[$x] =~ m/\"name\"/)&&($output[$x] =~ m/ID $maintname/)){
            $output[$x-1] =~ s/\[\{//g;
            $output[$x-1] =~ s/"//g;
            $output[$x-1] =~ s/maintenanceid://g;
            $output[$x-1] =~ s/result://g;
            $output[$x-1] =~ s/\{//g;
            $maintenanceid = $output[$x-1];
            remmaint($maintenanceid);
        }
        $x++;
    }
    if(!$maintenanceid){
       print "WARNING - $hostname not found in maintenance for Zabbix.\n";
       exit(1);
    }
}
 
 
#################################################
# Subroutine to add maintenance window to Zabbix
#
sub addmaint{
    $hostid = shift;
    $duration = shift;
    $maintname = shift;
    my $start = time();
    my $end = ($start + $duration);
    # my $auth = newrequest($url, $apiuser, $apipassword);
   my $process = 'curl -k -s -i -X POST -H \'Content-Type: application/json-rpc\' -d "{
    \"jsonrpc\":\"2.0\",
    \"method\":\"maintenance.create\",
    \"params\":[{
        \"groupids\":[],
        \"hostids\":[\"'.$hostid.'\"],
        \"name\":\"000_Manually Maintenance Mode with ID '.$maintname.' - '.$start.'\",
        \"maintenance_type\":\"0\",
        \"description\":\"000_Manually Maintenance Mode for '.$hostname.' set by Linux-Admin\",
        \"active_since\":\"'.$start.'\",
        \"active_till\":\"'.$end.'\",
        \"timeperiods\": [{
            \"timeperiod_type\": 0,
            \"start_date\": \"'.$start.'\",
            \"period\": '.$duration.'}]
        }],
    \"auth\":\"'.$auth.'\",
    \"id\":3}" '.$url; 
    my $res = `$process`;
    chomp($res);
 
    my @output = split(/,/,$res);
 
    foreach(@output){
    if ($_ =~ m/\"error/){
            print "$_\n";
        exit(1);
        }
        print "$_\n" if ($_ =~ m/\"result/);
    }
 
}
#################################################
# Subroutine to remove maintenance window from Zabbix
#
sub remmaint{
    $maintenanceid = shift;
    my $process = qq(curl -k -s -i -X POST -H 'Content-Type: application/json-rpc' -d '{
    "jsonrpc":"2.0",
    "method":"maintenance.delete",
    "params":["$maintenanceid"],
    "auth":"$auth",
    "id":2}' $url);
 
    my $res = `$process`;
    chomp($res);
 
    my @output = split(/,/,$res);
 
    foreach(@output){
        print "$_\n" if ($_ =~ m/\"error/);
        print "$_\n" if ($_ =~ m/\"result/);
    }
}

Das Skript stammt fast 1:1 von https://www.zabbix.org/wiki/Perl_script_to_add/remove_Maintenance
Ich habe es an die neueren Zabbix-Versionen angepasst bzw. die Host-Abfrage repariert.
Außerdem ignoriert es nun selbst signierte Zertifikate Ihr müsst in dem Skript die folgenden Zeilen anpassen:

my $url = "http://localhost/api_jsonrpc.php"; # change <zabbix server> to your zabbix server
my $apiuser="setmaintance"; # API User's Username
my $apipassword="abc123"; # API User's password

mit euren Daten. Die URL ist auf localhost, das sollte immer passen. Ggf. muss das auf localhost/zabbix geändert werden (je nachdem wie der Aufruf eures Zabbix Servers ist.
Wenn das Webinterface von Zabbix auf einem separaten Server installiert ist sollte ihr den entsprechenden DNS-Namen oder die IP dieses Servers eintragen. Das Skript selbst muss aber immer auf dem Zabbix-Server liegen.
Und ggf. https statt http

Im Anschluß müsst Ihr das Skript noch ausführbar machen:

chmod +x /usr/lib/zabbix/externalscripts/zabbix_main_host.pl



4 Skripts in Zabbix hinterlegen

Die Skripts findet Ihr unter
ClipCapIt-170620-202133.PNG


4.1 Wartung für Zeitraum X

Unter

Administration ==> Scripts

legen wir ein neues Script an:

Name      : Maintenance/1h
Type      : Script
Execute on: Zabbix Server
Commands  : /usr/lib/zabbix/externalscripts/zabbix_main_host.pl -s {HOST.HOST} -d 3600 -n via_Popup_Menu 2>&1

Am Ende sollte das so aussehen:
ClipCapIt-170620-202324.PNG
Unten könnte Ihr noch die Berechtigungen einstellen - so können auch Read-Only Benutzer einen Host in den Wartungsmodus setzen.
Das Skript könnt Ihr mehrmals klonen, ändert im Namen das 1h in den gewünschten Zeitraum, z.B. 4h und im Aufruf die 3600 auf die entsprechende Anzahl der Sekunden, z.B. 14400.

4.2 Wartung löschen

Diese Script löscht alle(!) zuvor erstellten Wartungspläne für den Host, egal ob noch gültig oder abgelaufen, die mit diesem Script erstellt wurden.

Name      : Maintenance/Delete All
Type      : Script
Execute on: Zabbix Server
Commands  : /usr/lib/zabbix/externalscripts/zabbix_main_host.pl -s {HOST.HOST} -r -n via_Popup_Menu 2>&1


ClipCapIt-170620-202634.PNG



5 Anwendung

Wir gehen in eine Ansicht in der man einen Hostnamen anklicken kann und man das übliche Popup-Menü erhält, zum Beispiel:

  • Trigger Ansicht
  • Event Ansicht
  • Latest Data (wenn mehr als ein Host dargestellt wird)
  • Maps


Dann kommt folgendes Menü:
ClipCapIt-170620-203146.PNG
Ich habe da noch ein paar mehr Einträge :-) Per Klick auf eine der Stunden wird der Host nun unmittelbar in den Wartungsmodus versetzt, dazu wird für jeden Host ein einzelner Wartungsplan erstellt.
Es öffnet sich ein neues Fenster in welchen Ihr den Erfolg betrachten könnt:
ClipCapIt-170620-205645.PNG


Wenn wir nun unter den Wartungsplänen nachsehen findet wir dort den per Skript erstellten:
ClipCapIt-170620-205814.PNG
ClipCapIt-170620-205849.PNG
ClipCapIt-170620-205912.PNG
ClipCapIt-170620-205948.PNG
Den Wartungsplan könnt Ihr natürlich auch dort direkt löschen, der bleibt bestehen auch nachdem dieser ausgelaufen ist.
oder halt auch per Popupmenü:
ClipCapIt-170620-210138.PNG


6 Proxy

Ich hatte es gerade bei einen Kunden das es nicht lokal vom Zabbix-Server aus funktionierte.
Grund war das der Befehl curl immer versucht hat die Seite über den Proxy aufzurufen - auch bei localost.
Lösung:
Ergänzt alle(!) curl Aufrufe im Skript um den Parameter

--noproxy localhost

7 Kommentare


MadMax

18 Monaten zuvor
Punktzahl 0++

Klappt wunderbar. :) (Zabbix Version 3.4.4)

Eine Anmerkung: Der Parameter $URL muss auf den Frontend Server verweisen und nicht auf den Zabbix Server, falls die Zabbix Rollen auf mehrere Server aufgeteilt ist.

BLinz

18 Monaten zuvor
Punktzahl 0++

Stimmt, habe ich auf meinem privaten Server sogar schon machen müssen.

Ich habe den Kommentar im Skript angepasst

Nico

4 Monaten zuvor
Punktzahl 0++

Hallo,

sehr coole Anleitung... ist die noch aktuell für Zabbix 3.4? Ich bekomme aktuell die Fehlermeldung

WARNING - HOSTNAME not found in maintenance for Zabbix.

Also für Hostname steht dann der Inhalt von {HOST.HOST} drin.....

BLinz

4 Monaten zuvor
Punktzahl 0++

Also läuft bei mir unter Zabbix 4.0 noch ohne Probleme - und lief auch vorher unter 3.4

Deine Meldung kommt wenn du die Wartungspläne des Hosts löschen willst, es aber gar keine gibt

Nico

4 Monaten zuvor
Punktzahl 0++

Ich habe bisher festgestellt, dass es nicht geht wenn ein Host neben dem Hostname noch einen "Visible Name" hat....

Hier ein Beispiel wo nur der Hostname vorhanden ist: /usr/lib/zabbix/externalscripts/zabbix_main_host.pl -s "10.6.5.101" -d 300 -n via_Popup_Menu Host ID: 15561 Adding maintenance for host 10.6.5.101 "result":{"maintenanceids":["20"]}

Hier ein Beispiel wo es nicht klappt: /usr/lib/zabbix/externalscripts/zabbix_main_host.pl -s "10.6.4.143" -d 300 -n via_Popup_Menu WARNING - 10.6.4.143 not found in maintenance for Zabbix.

Der Host selbst heißt 10.6.4.143.... hat aber zusätzlich noch einen sprechenden Namen im Feld Visible Name...

BLinz

4 Monaten zuvor
Punktzahl 0++
Dann teste mal {HOST.HOST} durch {HOST.NAME} zu ersetzen.

Nico

4 Monaten zuvor
Punktzahl 0++

Danke für den Feedback... Das wäre zu einfach ;-) Hab es in der WebGui geändert, aber ohne Erfolg....

Ich teste es direkt auf der Console mit dem Script.... Ich habe in der Subroutine "gethostid" die Kommentierung bei "print "$res ...." entfernt.

Wenn ich es mit der IP Adresse also in meinem Fall dem Hostname/$HOST.HOST versuche, ist das Ergebnis leer: /usr/lib/zabbix/externalscripts/zabbix_main_host.pl -s "10.1.4.51" -d 300 -n via_Popup_Menulll .... {"jsonrpc":"2.0","result":[],"id":2}

Wenn ich den Visible Name verwende also ($HOST.HOST), dann wir etwas zurückgeliefert, aber scheinbar nicht im gewünschten Format:

/usr/lib/zabbix/externalscripts/zabbix_main_host.pl -s "BBG-SW-18-4051" -d 300 -n via_Popup_Menulll ....

{"jsonrpc":"2.0","result":[{"hostid":"12859","proxy_hostid":"11111","host":"10.1.4.51","status":"0","disable_until":"0","error":"","available":"0","errors_from":"0","lastaccess":"0","ipmi_authtype":"0","ipmi_privilege":"2","ipmi_username":"","ipmi_password":"","ipmi_disable_until":"0","ipmi_available":"0","snmp_disable_until":"0","snmp_available":"2","maintenanceid":"0","maintenance_status":"0","maintenance_type":"0","maintenance_from":"0","ipmi_errors_from":"0","snmp_errors_from":"0","ipmi_error":"","snmp_error":"Timeout while connecting to \"10.1.4.51:161\".","jmx_disable_until":"0","jmx_available":"0","jmx_errors_from":"0","jmx_error":"","name":"BBG-SW-18-4051","flags":"0","templateid":"0","description":"","tls_connect":"1","tls_accept":"1","tls_issuer":"","tls_subject":"","tls_psk_identity":"","tls_psk":""}],"id":2}

Wenn ich das richtig sehe, wird nach Hostid gesucht, die ist im Ergebnis eigentlich enthalten, aber wir wohl nicht korrekt ausgewertet...

Leider fehlt es mir hier an den ausreichenden Perl Kenntnissen....

Nico

4 Monaten zuvor
Punktzahl 0++
Ach ja vergessen, aktuell zabbix_server (Zabbix) 3.4.15 im Einsatz.

Nico

4 Monaten zuvor
Punktzahl 0++

ok, erst nachdenken dann sieht man den Fehler.... In dem Ergebnis der Abfrage wird dann nochmal vergleichen, es wir in dem Array gesucht nach dem Feld "Host" in dem der übergebenen Parameter "$Hostname" stehen muss.

In dem Fest "Host" das im JSON Zurückgegeben wird, steht HOST.HOST drin... wenn man natürlich HOST.NAME abfragt, kann es nicht matchen....

Scheinbar kann man der API Funktion Host.GET kein HOST.HOST mit dem Werte einer IP Adresse übergeben... Leider sind meine Host fast alle so angelegt... Der eigentliche Menchenlesbare Name steht immer im Visible Name Feld.

Wenn ich den Hostname von 10.1.4.51 in BBG-SW-18-4051 in der GUI ändere, geht es auch mit HOST.HOST

Nico

4 Monaten zuvor
Punktzahl 0++

So und nun die Endlösung... in der Abfrage muss nicht nach "Name" sondern nach "Host" gefiltert werden:

"params": { "filter": { "name": "$hostname"


"params": { "filter": { "host": "$hostname"


Als Name wird bei Host ohne Visible Name der Hostname zurückgeliefert, darum geht es dort ohne Probleme. Bei Hosts die zusätzlich einen Visible Name haben, wird dieser als Name zurückgeliefert. Im Feld Host steht der Hostname, genau der Parameter der auch in der Abfrage übergeben wird, wenn man {$HOST.HOST} verwendet....

Sorry für die Vielen Posts, zur Not lösche die Vorherigen bitte wieder....

Danke Nico
Kommentar hinzufügen
znilwiki freut sich über alle Kommentare. Sofern du nicht anonym bleiben möchtest, trage deinen Namen oder deine Email-Adresse ein oder melde dich an. Du kannst das Feld auch einfach leer lassen. Bei einem Kommentar wird deine IP-Adresse zusammen mit dem Text, den angegebenen Namen bzw. der Email-Adresse in der Datenbank für die Kommentare dauerhaft gespeichert. Genaueres kannst du hier nachlesen: Datenschutzerklärung