Pi-hole

Pi-hole (ab Version 6) über die REST-API in Symcon überwachen und steuern.

Stable 2.0Beta 2.01.478 Downloads114 in 30 Tagen

Privat kostenlos Gewerblich auf Anfrage Anfrage senden

Diese Dokumentation beschreibt immer die neueste Version des Moduls, aktuell 2.0 im Kanal Beta.

PiHole Maintenance

Führt Wartungsaktionen am Pi-hole aus (Gravity aktualisieren, DNS neu starten, Caches und Logs leeren) und sichert oder stellt die Konfiguration über den Teleporter wieder her. Die Instanz braucht den PiHole Splitter und wird manuell angelegt. Die Kachel startet Gravity-Update, DNS-Neustart und das Leeren des ARP-Caches per Klick und zeigt die letzte Ausführung. Logs und Netzwerktabelle lassen sich nur über die Variable und die Funktionen leeren.

Inhaltsverzeichnis

1. Konfiguration

Die Instanz hat keine Einstellungen. Im Konfigurationsformular lassen sich “Gravity aktualisieren” und “DNS neu starten” nach einer Rückfrage auslösen.

2. Variablen

VariableIdentTypBeschreibung
AktionActionGanzzahl (Aufzählung)Löst eine Wartungsaktion aus: 1 Gravity aktualisieren, 2 DNS neu starten, 3 Logs leeren, 4 ARP-Cache leeren, 5 Netzwerktabelle leeren. Steuerbar.
Letztes ErgebnisLastResultTextName der letzten Aktion und ob sie erledigt wurde.
Letzte AusführungLastRunDatum/UhrzeitZeitpunkt der letzten Aktion.

3. Funktionen

Beim Aufruf aus Skripten müssen alle Parameter angegeben werden, Standardwerte gelten dort nicht. Übliche Werte: Gruppen [0], Aktiv true, Anzahl 10, Listentyp block, alle übrigen optionalen Parameter leer (''), 0 oder false. Die Aktionen liefern die Ausgabe des Pi-holes als Text.

string PIHMAINT_UpdateGravity(integer $InstanzID); Aktualisiert die Blocklisten. Das kann einige Minuten dauern und belegt solange die Verbindung des Splitters.

string PIHMAINT_RestartDNS(integer $InstanzID); Startet den DNS-Server neu.

string PIHMAINT_FlushLogs(integer $InstanzID); string PIHMAINT_FlushNetwork(integer $InstanzID); Leert die Logdateien beziehungsweise die Netzwerktabelle. Der Pi-hole erlaubt das nur, wenn destruktive Aktionen aktiviert sind.

string PIHMAINT_FlushARP(integer $InstanzID); Leert den ARP-Cache.

boolean PIHMAINT_ExportTeleporter(integer $InstanzID, string $Path); Speichert ein Teleporter-Backup als ZIP-Datei unter $Path. Der Ordner muss existieren. Liefert true bei Erfolg.

string PIHMAINT_ImportTeleporter(integer $InstanzID, string $Path, string $Options); Spielt ein Teleporter-Backup ein und überschreibt dabei vorhandene Daten. $Options wählt die Bereiche als JSON, zum Beispiel {"config":true,"gravity":{"group":true,"adlist":true}}. Leer importiert alles.

4. Spenden

Dieses Modul ist für die nicht kommerzielle Nutzung kostenlos, Schenkungen als Unterstützung für den Autor werden hier akzeptiert:

PayPal Amazon Wunschzettel

5. Lizenz

CC BY-NC-SA 4.0