PRTG PowerSHELL API

Posted on: 14. Juni 2018
Die PRTG API ist eine Drittsoftware API die man als Modul in PowerSHELL installieren bzw. importieren kann. Damit lässt sich fast das komplette PRTG mittels PowerSHELL verwalten und dies auf eine wesentlich schnellere und effizientere Weise als über die Webseite von PRTG selbst.

Hier ein paar Beispiele was man mit der API alles machen kann, sowie alle Hilfedateien zu den Befehlen als Download.
Hier der Code aus dem Youtube-Video. Die Vorgehensweise und Bemerkungen findest du direkt als Kommentare (#Grün) im Code. So wird er dir ebenfalls in der PowerSHELL ISE angezeigt werden.
——————————————–
# Modul PRTG API installieren            
Install-Module prtgapi            
Import-Module prtgapi            
            
# Falls nötig vorgängig auf "set-executionmode unrestricted" stellen            
# Set-ExecutionPolicy Unrestricted            
            
# Auf PRTG Server verbinden            
Connect-PrtgServer -Server "127.0.0.1"            
            
# PRTG Status abfragen mit einigen Statistik-Infos            
Get-PrtgStatus            
            
# Sensoren nach Status auflisten            
Get-Sensor -Status Down            
            
# Sensor History anschauen            
Get-SensorHistory -Sensor (Get-Sensor -id 3962) -EndDate (Get-Date).AddDays(-7) -StartDate (Get-Date) -Average 3600            
            
# Webseite eines Sensors im Browser öffnen            
Open-PrtgObject -Object (Get-Sensor -id 3962)            
            
# Fehlerhafter Sensor bestätigen für 7 Stunden            
Acknowledge-Sensor -Sensor (Get-Sensor -id 3962) -Message "Bestätigungsnachricht" -Duration (Get-Date).AddHours(7)            
            
# Fehler Simulieren            
Test-ErrorStatus -Sensor (Get-Sensor -id 3962)            
            
# Sensor jetzt prüfen            
Refresh-Object -Object (Get-Sensor -id 4593)            
            
# Sensor pausieren für 5 Minuten mit Nachricht            
Suspend-Object -Object (Get-Sensor -id 4593) -Message "Test" -Until (Get-Date).AddMinutes(5)            
            
# Sensor fortsetzen nach Pause            
Resume-Object -Object (Get-Sensor -id 4593)            
            
# Backup der PRTG Konfiguration erstellen ins definierte Backup-Verzeichnis            
Backup-PrtgConfig            
            
# PRTG Core neustarten nach 15 Minuten (900 Sekunden)            
Restart-PrtgCore -Timeout 900            
            
# PRTG Probe neustarten nach 1 Minute (60 Sekunden)            
Restart-Probe (Get-Probe -id 1234) -Timeout 60
——————————————–
Solltest du irgendwelche Fragen haben, dann kannst du diese gerne entweder hier im Blog oder direkt unter dem YouTube Video stellen. Ich gebe alles, deine Fragen zeitnahe zu beantworten oder ein entsprechendes Video darüber zu machen.
Gerade die Grundlagen-Videos werde ich nicht mit viel Text ausschmücken. Bei mir ist jeweils jede Code-Zeile direkt im Code Kommentiert (#Grün). Du kannst den Code direkt mit in dein Script kopieren und hast so eine gute Orientierungshilfe, sobald du die Scripts auf deine Bedürfnisse anpasst.

Ich erstelle und veröffentliche sämtliche Videos kostenlos und blende auch keine Werbung ein, dies will ich auch so beibehalten. Da das vermittelte Wissen aber in teuren Kursen erlangt werden kann, ist eine kleine Spende hin und wieder sicher keine schlechte Gegenleistung.