/
SHD PRTG Addon

SHD PRTG Addon

Einführung

Der PRTG-Adapter verbindend i-doit mit Paesslers PRTG-Software. Der Adapter erweitert zum einen das Livestatus-Modul von i-doit. Des Weiteren stellt der Adapter einen eigenen Importer auf Basis des Livestatus-Clients von SHD bereit. Zuletzt können Funktionen des cmk2 Addons von SHD für PRTG-Systeme ausgeführt werden. Dieser Adapter und diese Dokumentation befindet sich zurzeit im Beta-Status.

Installation & Update

Die Installation erfolgt, indem das ZIP-Archiv mit dem Addon im i-doit Admin Center hochgeladen wird. Eine neue Version kann durch das hochladen des neusten ZIP-Archives geupdatet werden. Es wird empfohlen, die neuste Version zu installieren. Ebenfalls wird die i-doit Version 38 empfohlen.

Rechteverwaltung

Der PRTG-Adapter erweitert das i-doit Rechtesystem um eigene Rechte. Fast alle Funktionen sind hinter standardmäßig gesperrt und müssen für die entsprechenden Nutzer freigegeben werden. Im Administration-Baum unter Berechtigungen > SHD VIEW PRTG können die Rechte zugewiesen werden.

image-20260223-090706.png

 

Zum aktuellen Zeitpunkt gibt es vier Berechtigungen

  • SHD VIEW PRTG Profile verwalten: Hier wird zwischen Lese- und Schreibberechtigung unterschieden. Die Leseberechtigung wird benötigt, um sich PRTG Profile, sowie die Software Black- und Whitelist anzeigen zu lassen. Daneben wird sie auch noch benötigt, um in der PRTG-Monitoring Kategorie das PRTG Profil zu ändern und um auf die Importseite zugreifen zu können. Die Schreibberechtigung gewährt alle Leseberechtigungen. Daneben dürfen mit ihr auch noch die PRTG Profile, die Software-Blacklist und die Software Whitelist bearbeitet werden.

  • SHD VIEW PRTG Import: Der PRTG Import besteht nur aus einer Ausführungsberechtigung. Damit wird dem Nutzer erlaubt, auf der Importseite Geräte zu importieren. Zusätzlich wird in der PRTG Monitoring Kategorie der Button Update freigeschaltet

  • SHD VIEW PRTG Export: Auch der PRTG Export besteht nur aus einer Ausführungsberechtigung. Er schaltet den Button Export in der PRTG Monitoring Kategorie frei

  • SHD VIEW PRTG Admin: Hier gibt es nur eine Adminberechtigung. Diese ersetzt alle anderen Berechtigungen und gibt somit Zugriff auf alle SHD VIEW PRTG Funktionen.

Einrichtung und Erste Schritte

Um den Adapter nutzen zu können, muss im i-doit zuerst ein PRTG Profil angelegt werden. Dafür wird ein Schreiberechtigung auf die Berechtigung PRTG Profile verwalten benötigt. Der Adapter fügt im Administrations-Baum unter Import und Schnittstellen > Monitoring den neuen Unterpunkt PRTG Profile ein. Wenn der Unterpunkt nicht zu finden ist, wird höchstwahrscheinlich eine fehlende Berechtigung die Ursache sein. Der Nutzer benötigt mindestens die Leseberechtigung auf SHD VIEW PRTG Profile, um den Unterpunkt zu sehen. Zum Bearbeiten wird zusätzlich die Schreibberechtigung gebraucht.

image-20260420-085852.png

Folgende Optionen stehen zur Verfügung:

  • Neu: Erstellt ein neues Profil

  • Editieren: Bearbeitet das ausgewählte Profil

  • Löschen: Löscht die ausgewählten Profile

  • Duplizieren: Kopiert die ausgewählten Profile

Die Optionen Neu und Editieren öffnen folgendes Fenster:

image-20260420-090205.png

 

Die Felder sind wie folgt auszufüllen:

  • Titel: Dieser kann frei gewählt werden, bei vielen PRTG Profilen empfiehlt sich jedoch ein eindeutig identifizierbarer Name

  • Aktiv: Dadurch kann ein PRTG Profil i-doit seitig deaktiviert werden

  • Protokoll: Der Adapter unterstützt HTTP und HTTPS, um mit PRTG zu kommunizieren. Es wird jedoch empfohlen HTTPS zu verwenden, da dieses sicherer ist. HTTP sollte nur verwendet werden, wenn HTTPS nicht funktioniert und die Verbindung zwischen i-doit und PRTG keine Verschlüsselung benötigt. Die Verwendung von HTTP stellt ein Sicherheitsrisiko da, weil die Daten nicht verschlüsselt werden und mitgelesen werden können.

  • Netzwerkadresse: Die Netzwerkadresse kann entweder der DNS Name oder die IP-Adresse des Systems sein, auf welchem der PRTG-Core Server ausgeführt wird. Es wird empfohlen den DNS Namen zu verwenden, da die IP-Adresse sich ändern kann.

  • API-Schlüssel: Dieser muss im PRTG erstellt werden und hier eingefügt werden. Mehr dazu in Kapitel API-Schlüssel erstellen. SHD PRTG Addon

  • Master PRTG-ID: Um den Export nutzen zu können, ist es erforderlich, im PRTG ein Gerät zu erstellen, aus welchem alle Exportierten Geräte erzeugt werden. Es ist sinnvoll dem Master Gerät im PRTG den Sensor Ping hinzuzufügen, damit alle exportierten Geräte diesen ebenfalls bekommen. Die PRTG-ID dieses Objektes soll hier eingetragen werden. Der Adapter ist in der Lage Vorschläge zu erzeugen, falls die oberen Daten richtig ausgefüllt wurden.

  • Objekttype: Legt fest welchen Objekttypen neu anzulegende Geräte haben sollen. Wenn ein Gerät, welches noch nicht im i-doit vorhanden ist über das Profil importiert wird, bekommt es automatisch den Typen. Der Objekttyp von bereits vorhandenen Geräten wird jedoch nicht überschrieben. Sollte kein Objekttyp ausgewählt sein, können Objekte nicht neu erstellt werden. Das Aktualisieren ist jedoch trotzdem möglich.

  • Text Interpretation: PRTG speichert Daten, welche Relevanz für i-doit haben nur als einfachen Text ab. Die Einfache Textinterpretation durchsucht diese Texte und schaut, ob sie in dem Text Wörter findet, welche bereits im i-doit abgespeichert sind. Das können zum Beispiel Herstellernamen oder Modellnamen sein. Die erweiterte Textinterpretation nutzt dann noch zusätzlich Regulare Ausdrücke, um noch mehr Daten aus dem Text zu gewinnen. Beide können jedoch auch Fehler machen, weswegen die Importierten Daten danach einmal überprüft werden sollten. Trotzdem ist die erweiterte Textinterpretation empfohlen.

  • Kategorienfilter: Es ist möglich mithilfe des Kategorienfilters das Befüllen von bestimmten Kategorien beim Import zu Unterbinden. Hierfür muss einfach die Check Box vor der Kategorie abgewählt werden. Es kann sein, dass obwohl eine Kategorie ausgewählt ist, diese trotzdem nicht importiert wird. In dem Fall hat höchstwahrscheinlich PRTG selbst keinen Zugriff auf diese Daten. Es können alle zu importierenden Kategorien unterbunden werde, bis auf die PRTG Monitoring Kategorie. Da anhand der PRTG Monitoring Kategorie abgelesen werden kann, ob ein Objekt im i-doit schon existiert oder nicht, darf diese Kategorie nicht gefiltert werden. Standardmäßig sind alle Kategorien aktiv, was bedeutet, dass sie beim Import befühlt werden.

  • Verbindungstest: Dieser Button führt den Verbindungstest durch. Mehr dazu im Kapitel Verbindungstest. SHD PRTG Addon

  • Erweiterte Einstellungen: Mit diesem Button können die Erweiterten Einstellungen ausgeklappt werden. Normalerweise ist dies jedoch nicht nötig. Änderungen an den Erweiterten Einstellungen stellen ein Sicherheitsrisiko dar. Mehr dazu im Kapitel Erweiterte Einstellungen. SHD PRTG Addon

  • Software Whitelist: Hier können verschiedene Listeneinträge aus der Software Whitelist ausgewählt werden, welche dann auf die Importe über dieses Profil angewendet werden sollen.

  • Software Blacklist: Hier können verschiedene Listeneinträge aus der Software Blacklist ausgewählt werden, welche dann auf die Importe über dieses Profil angewendet werden sollen. SHD PRTG Addon

API Schlüssel erstellen

In der PRTG Weboberfläche kann unter Konfiguration > Kontoeinstellungen > API Schlüssel eine Übersicht mit allen Schlüsseln aufgerufen werden.

image-20250805-121759.png

Neben der Tabelle befindet sich eine + Schalfläche. Fährt man nun mithilfe der Maus über diese so erscheinen zwei Optionen. Um einen API Schlüssel für den PRTG Adapter erstellen muss die Option API-Schlüssel hinzufügen gewählt werden. Es öffnet sich ein neues Fenster, wo Name und Zugriffslevel eingeben werden können.

image-20250805-121946.png

Die Felder sind wie folgt auszufüllen:

  • Name: Dieser kann frei gewählt werden. Hier empfiehl sich i-doit oder ähnlich zu wählen.

  • Zugriffslevel: Gibt an welche Berechtigung die API im PRTG bekommt. Zum Exportieren benötigt der Adapter mindestens einen Schreibzugriff.

Beide Attribute können später noch bearbeitet werden. Bevor man die Eingabe mit OK bestätigt, muss der API-Schlüssel kopiert und irgendwo anders sicher abgespeichert werden. Es ist später nicht mehr möglich diesen API-Schlüssel auszulesen. Wurde der Schlüssel sicher gespeichert kann die Eingabe mit der Schaltfläche Ok bestätigt werden. Weitere Informationen: API Keys | PRTG Manual

Verbindungstest

Sollten andere Funktionen nicht richtig funktionieren empfiehlt es sich immer zuerst einen Verbindungstest durchzuführen, um Verbindungsprobleme auszuschließen oder zu lösen. Wenn die Verbindung funktioniert wird außerdem noch die PRTG Version und die Existenz des Mastergerätes überprüft. Die Ergebnisse werden in einem neuen Fenster angezeigt. Sind alle Daten richtig sieht der Test wie folgt aus, andernfalls zeigt er einen Fehler oder eine Warnung:

image-20250805-123503.png

Der Test kann in der rechten oberen Ecke mit x geschlossen werden.

Erweiterte Einstellung

image-20250804-135321.png

Die erweiterten Einstellungen bestehen aus den folgenden Feldern:

  • Peer verifizieren: Es wird empfohlen dieses Feld auf Ja zu stellen. Bei der Kommunikation mit PRTG können Zertifikate mitgeschickt werden, um die Sicherheit zu gewährleisten. Dieses Zertifikat wird überprüft, falls das Feld auf Ja steht. Sollte das Feld auf Nein stehen, wird das Zertifikat nicht überprüft, was ein Sicherheitsrisiko darstellt. Das Feld sollte nur auf Nein gestellt werden, wenn die Sicherheit weiterhin gegeben ist. Weitere Informationen können unter folgendem Link gefunden werden: Framework Configuration Reference (FrameworkBundle) (Symfony Docs)

  • Host verifizieren: Es wird empfohlen dieses Feld auf Ja zu stellen. Sollte dieses Feld aktiviert sein, wird der Sender des Zertifikates ebenfalls überprüft. Auch dieses Feld stellt auf Nein ein Sicherheitsrisiko da. Weitere Informationen können unter folgendem Link gefunden werden: Framework Configuration Reference (FrameworkBundle) (Symfony Docs)

Importieren eines PRTG-Geräts

Das Importieren eines PRTG-Geräts kann unter Add-Ons > SHD Connect PRTG erfolgen. Dies Seite kann nur eingesehen werden, wenn der Nutzer mindestens die Leseberechtigung zum Verwalten der SHD VIEW PRTG Profile hat. Zum Importieren wird zudem die Ausführberechtigung für PRTG Import benötigt.

image-20260223-091950.png

Auf der linken Seite kann das PRTG Profil ausgewählt werden, welche das zu importierende PRTG Objekt beinhaltet.

image-20260223-092934.png

Wenn das PRTG Profil richtig eingerichtet wurde, wird hier eine Liste mit allen PRTG Geräten und Gruppen angezeigt. Die Einstellungsmöglichkeiten sind bereits vorher im jeweiligen PRTG Profil anzupassen.

Die Einstellungsmöglichkeiten bei Importiere Gruppe, sowie der Button Importiere ausgewählte ist für den einfachen Import unwichtig. Der einfach Import wird gestartet, indem auf der Button Import in der Zeile mit dem gewünschten Gerät gedrückt wird. Wurde ein Gerät bereits importiert, so ändert sich das Optionenfeld. Das Symbol mit Büroklammer und grünem Pfeil ist ein Link zum i-doit Objekt. Der Button Aktualisieren aktualisiert das verlinkte i-doit Objekt.

image-20251014-102045.png

Daten, die importiert werden können

Die Daten welche durch den Import ausgefüllt werden, hängen von den Daten ab, die PRTG im System Informations Tab bereitstellt. Die nachfolgende Tabelle zeigt welche Daten importiert werden können:

i-doit Kategorie

Multi-Value Kategorie

Externes Objekt

Keine Textinterpretation

Einfache Textinterpretation

Erweiterte Textinterpretation

i-doit Kategorie

Multi-Value Kategorie

Externes Objekt

Keine Textinterpretation

Einfache Textinterpretation

Erweiterte Textinterpretation

Allgemein

Nein

Nein

  • Bezeichnung

 

 

Host-adresse

Ja

Nein

  • Typ

  • Zuordnung eines Netzes

  • Primär / Aktiv

  • IPv4-Adresse 

  • IPv6-Adresse

  • Hostname (FQDN)

  • verknüpfter Port

 

 

CPU

Ja

Nein

  • Bezeichnung    

  • Beschreibung

  • Hersteller

  • Typ

  • CPU-Frequenz (Einheit)

  • CPU-Frequenz

Netzwerk

Ja

Nein

  • Bezeichnung    

  • Beschreibung

  • Hersteller

  • Modell

 

Lokaler Massen-speicher > Gerät

Ja

Nein

  • Typ

  • Bezeichnung

  • Seriennummer

  • Beschreibung

  • Hersteller

  • Modell

 

Laufwerk

Ja

Nein

  • Bezeichnung

  • Seriennummer

  • Beschreibung

 

  • Laufwerks-buchstabe/
    Mount Point

Model

Nein

Nein

  • Firmware

 

 

Monitoring >
PRTG Monitoring

Nein

Nein

  • Aktiv?

  • ID in PRTG

  • PRTG Profil

  • Hauptsensor

 

 

Netzwerk>Port

Ja

Nein

  • Bezeichnung

  • verknüpftes Interface

  • MAC-Adresse

 

 

Software Zuordnung

Ja

Mehrere

  • Software

  • Version

  • Anwendung → Hersteller

  • Anwendung → Version

 

 

Betriebs-system Zuordnung

Ja

Eins

  • Betriebssystem

  • Anwendung → Hersteller

 

 

Multi-Value Kategorien sind Kategorien, welche mehr als ein Eintrag pro Objekt erlauben, zum Beispiel Hostadresse. Manche Kategorien erfordern, dass weitere Objekte angelegt werden, zum Beispiel benötigt Betriebssystem Zuordnung ein Betriebssystem Objekt. Die Textinterpretation kann im PRTG Profil mit eingestellt werden.

Filtern von Software

Beim Import von Software kann es vorkommen, dass viele neue Objekte erzeugt werden, da für jede Software ein neues Objekt angelegt werden muss. Um die zu importierende Software zu filtern stellt der Adapter eine Black und Whitelist für jedes Profil bereit. Zuerst wird geprüft ob der Name der Software auf der jeweiligen Blacklist steht. Jede Software die auf der Blacklist steht wird nicht importiert. Als zweites wird geschaut, ob die Software auf der jeweiligen Whitelist zu finden ist. Nur falls dies der Fall ist wird sie im i-doit importiert. Im Administrationsbaum unter “PRTG Profile” können neue Listeneinträge angelegt werden, damit diese dann in den einzelnen PRTG Profil ausgewählt werden können.

image-20260223-093515.png

Hier stehen folgende Optionen zur Verfügung:

  • Neu: Erstellt einen neuen Listeneintrag

  • Editieren: Bearbeitet den ausgewählten Listeneintrag

  • Löschen: Löscht den ausgewählten Eintrag

Durch Neu oder Editieren öffnet sich folgendes Fenster:

image-20260420-091940.png

Hier stehen die folgenden Felder zur Verfügung:

  • Titel/Pattern: Hier wird der Name der zu filternden Software eingetragen. Zudem ist es auch möglich reguläre Ausdrücke anzugeben, um mehrere Software mit einem Eintrag zu filtern. Die Delimiters für reguläre Ausdrücke, zum Beispiel Schrägstriche(/) werden im Hintergrund hinzugefügt und müssen nicht angegeben werden. Es reicht nur das Pattern in die Zeile zu schreiben. Mehr zu regulären Ausdrücken kann unter folgendem Link gefunden werden: PHP: PCRE regex syntax - Manual

  • Aktiv: Hiermit können vereinzelte Listeneinträge ein und ausgeschaltet werden.

  • Beschreibung: Die Wirkung von komplexen regulären Ausdrücken kann nur schwer aus dem Pattern herausgelesen werden. Die Beschreibung kann Abhilfe schaffen, indem sie den Ausdruck erklärt

Nachdem der Listeneintrag gespeichert wurde, muss er noch den jeweiligen Profilen zugeordnet werden.

Das Pattern .* kann wie im Bild in der Whitelist verwendet werden, um jede Software zu importieren. In der Blacklist sorgt das Pattern dafür, dass alle Software abgelehnt werden.

Importieren mehrerer Geräte

Neben Einzelimporten ist es auch möglich, mehrere Geräte gleichzeitig zu importieren. Dafür wird zum einen mindestens die Leseberechtigung zum Verwalten der SHD VIEW PRTG Profile und die Ausführberechtigung für PRTG Import. Zum Importieren gibt es aktuell vier Möglichkeiten:

Import ausgewählter Geräte

image-20260223-093940.png

 

In der letzten Spalte der Geräte Tabelle können beliebig viele PRTG-Geräte an und abgewählt werden. Im Tabellenkopf können zusätzlich alle PRTG-Geräte an und abgewählt werden. Die Einstellungsmöglichkeiten sind vorher im PRTG Profil festzulegen.

Der Import wird gestartet, indem auf Importiere ausgewählte geklickt wird.

Import von PRTG Gruppen

image-20260223-094035.png

Für den Import von Gruppen ist nur die obere Tabelle relevant. Hier können die folgenden Optionen eingestellt werden:

  • Gruppe: Auswahl der Gruppe, aus welcher alle Geräte importiert werden

  • Rekursionstiefe: Gibt an, wie tief Geräte in weiteren tieferen Gruppen importiert werden. So bedeutet das bei einer Tiefe von 1 nur Geräte importiert werden, welche in der ausgewählten Gruppe zu finden sind. Eine Tiefe von 2 bedeutet wiederum, dass zum einen alle Geräte aus der ausgewählten Gruppe importiert werden und dazu noch Geräte aus Gruppen, welche wiederum in der ausgewählten Gruppe anzufinden sind. Für eine Tiefe von 3 und mehr ist die Auswahl analog. Eine Tiefe von 0 ist ebenfalls möglich. Dadurch werden alle Geräte aus der Gruppe, sowie tieferen Gruppen importiert, egal wie tief sie aufzufinden sind. Ist die ausgewählte Gruppe die PRTG-root Gruppe, und die Rekursionstiefe 0, so werden alle PRTG-Geräte importiert

Dazu werden auch noch die Einstellung des jeweiligen PRTG Profils angewendet, wie zum Beispiel der Objekttype für neue Geräte.

Der Import kann dann durch einen Klick auf Importiere Gruppe gestartet werden.

Importieren von PRTG-Geräten mit bestimmten Tags

image-20260223-094146.png

Für den Import von PRTG-Geräten mit bestimmten Tags ist nur die obere Tabelle relevant. Hier können die folgenden Optionen eingestellt werden:

  • Tags: Hier werden die PRTG-Tags eingestellt. Es ist möglich beliebig viele Tags hinzuzufügen. Im PRTG dürfen Tags keine Leerzeichen enthalten, weswegen das Leerzeichen verwendet werden kann, um einen neuen Tag zu schreiben. Durch das Plus Symbol neben dem Schreibfeld kann ebenfalls mit dem schreiben eines neuen Tags begonnen werden. Bei mehreren Tags werden nur die Geräte importiert, welche auch alle Tags besitzen.

Dazu werden auch noch die Einstellung des jeweiligen PRTG Profils angewendet, wie zum Beispiel der Objekttype für neue Geräte.

Der Import kann dann durch einen Klick auf Importiere Geräte mit Tags gestartet werden.

Import von Geräten aus einer PRTG Gruppe mit bestimmten Tags

Ebenfalls ist es möglich, den “Gruppenfilter” und den “Tagfilter” zu kombinieren.

image-20260223-094209.png

Dafür stehen die folgenden Optionen zur Verfügung:

  • Gruppe: Auswahl der Gruppe, aus welcher Geräte importiert werden

  • Rekursionstiefe: Gibt an, wie tief Geräte in weiteren tieferen Gruppen importiert werden. So bedeutet das bei einer Tiefe von 1 nur Geräte importiert werden, welche in der ausgewählten Gruppe zu finden sind. Eine Tiefe von 2 bedeutet wiederum, dass zum einen Geräte aus der ausgewählten Gruppe importiert werden und dazu noch Geräte aus Gruppen, welche wiederum in der ausgewählten Gruppe anzufinden sind. Für eine Tiefe von 3 und mehr ist die Auswahl analog. Eine Tiefe von 0 ist ebenfalls möglich. Dadurch werden Geräte aus der Gruppe, sowie tieferen Gruppen importiert, egal wie tief sie aufzufinden sind. Ist die ausgewählte Gruppe die PRTG-root Gruppe, und die Rekursionstiefe 0, so werden alle PRTG-Geräte importiert

  • Tags: Hier werden die PRTG-Tags eingestellt. Es ist möglich beliebig viele Tags hinzuzufügen. Im PRTG dürfen Tags keine Leerzeichen enthalten, weswegen das Leerzeichen verwendet werden kann, um einen neuen Tag zu schreiben. Durch das Plus Symbol neben dem Schreibfeld kann ebenfalls mit dem schreiben eines neuen Tags begonnen werden. Bei mehreren Tags werden nur die Geräte importiert, welche auch alle Tags besitzen.

Dazu werden auch noch die Einstellung des jeweiligen PRTG Profils angewendet, wie zum Beispiel der Objekttype für neue Geräte.

Der Import kann dann durch einen Klick auf Importiere Geräte aus Gruppe mit Tags gestartet werden.

Import über die Kommandozeile

Unter Nutzung der Kommandozeile ist es ebenfalls Geräte aus PRTG zu importieren. Auch hier gibt es wieder die vier Möglichkeiten, wie beim SHD PRTG Addon über die Nutzeroberfläche. Die Befehle können ausschließlich im Standard i-doit Verzeichnis genutzt werden. Der Cron Generator kann genutzt werden, um das Standard Verzeichnis zu finden.

Konfigurationsdatei

Alle Befehle benötigen Zugangsdaten für i-doit. Es ist zwar möglich diese im Befehl mit anzugeben, jedoch aus Sicherheitsgründen nicht empfohlen. Deswegen bietet i-doit die Möglichkeit eine Konfigurationsdatei zu nutzen. Wichtig ist, dass diese Datei sich an einem sicherem Ort im System befindet und nur vom Besitzer gelesen werden kann. Zudem macht es Sinn für Importe über die Kommandozeile und automatisierte Importe einen neuen Benutzer anzulegen, welcher minimale Rechte für den Import besitzt. Die Datei sollte beispielsweise config.ini heißen und wie folgt aussehen:

[commandOptions] user = admin password = admin

Neben user und password können auch noch andere Kommando Optionen im selbem Schema mit angegeben werden. Der Cron Generator schreibt andere Optionen jedoch immer in den Befehl. Standardmäßig ist die Konfigurationsdatei nicht verschlüsselt und speichert die Zugangsdaten im Klartext. Eine eigene Lösung mit Verschlüsslung, welche die Kommandozeile als Schnittstelle nutzt, kann ebenfalls sinnvoll sein, um noch mehr Sicherheit zu gewährleisten.

Auch ist es wichtig, dass der eingetragene Nutzer die Ausführberechtigung für den PRTG Import hat.

Import durch PRTG-IDs

Der Import durch PRTG-IDs bildet den SHD PRTG Addon in der Kommandozeile ab. Der Befehl hat folgende Syntax:

php console.php prtg-import-by-ids [-u|--user USER] [-p|--password PASSWORD] [-i|--tenantId TENANTID] [-c|--config CONFIG] [--] <prtg-host-id> [<prtg-ids>...]

Der Befehl benötigt die folgenden Argumente in selber Reihenfolge:

  • prtg-host-id: Die PRTG-Host ID wird beim anlegen eines PRTG Profil im i-doit automatisch erstellt. Diese wird verwendet, um Informationen, wie Host Adresse und API Schlüssel über die PRTG Instanz zu speichern. Zudem beinhaltet das Profil auch verschiedene Einstellmöglichkeiten, zum Beispiel den Objekttyp für neu zu erstellende Geräte. Die ID kann unter Verwaltung > PRTG Profile ausgelesen werden.

  • prtg-ids: Die PRTG IDs dienen zum identifizieren der Geräte im PRTG. Diese können im PRTG unter der Geräteübersicht des jeweiligen Geräts ausgelesen werden. Mehrere PRTG-IDs können mit Leerzeichen angegeben werden.

Daneben gibt es folgende Optionen, welche meist nicht zwingend benötigt werden:

  • config: Gibt den Pfad zur Konfigurationsdatei inklusive Dateinamen an. Hier empfiehlt es sich absolute Pfade zu nutzen. Eine Konfigurationsdatei kann von mehreren Befehlen genutzt werden, solang sie nur Optionen beinhaltet, welche von allen Befehlen unterstützt werden. Für Befehle des PRTG Adapters sind, dass neben den Standardoptionen user, password und tenantId, die Oprionen level und objecttype. Diese Option wird immer benötigt, da Nutzername und Passwort zumindest in der Konfigurationsdatei stehen sollten und nicht im eigentlichen Befehl. Mehr dazu im Kapitel SHD PRTG Addon

  • user: Der i-doit Nutzername des Benutzers, der die PRTG Geräte importieren soll und kann. Diese Option sollte immer in einer sicheren Konfigurationsdatei stehen und nicht im Befehl selbst. Der Nutzername wird immer benötigt. Mehr dazu im Kapitel SHD PRTG Addon

  • passwort: Das i-doit Passwort des Benutzers, der die PRTG Geräte importieren soll und kann. Diese Option sollte immer in einer sicheren Konfigurationsdatei stehen und nicht im Befehl selbst. Das Passwort wird immer benötigt. Mehr dazu im Kapitel SHD PRTG Addon

  • tenantId: Gibt die ID des Tenants an. Bei einem Tentant kann diese Option auch weggelassen werden

Import durch PRTG Gruppen ID

Der Import durch die PRTG Gruppen ID bildet den SHD PRTG Addon in der Kommandozeile ab. Der Befehl hat folgende Syntax:

php console.php prtg-import-by-group [-d|r|--recursion-depth RECURSION-DEPTH] [-u|--user USER] [-p|--password PASSWORD] [-i|--tenantId TENANTID] [-c|--config CONFIG] [--] <prtg-host-id> <group-id>

Der Befehl benötigt die folgenden Argumente in selber Reihenfolge:

  • prtg-host-id: Die PRTG-Host ID wird beim anlegen einer PRTG Profil im i-doit automatisch erstellt. Diese wird verwendet, um Informationen, wie Host Adresse und API Schlüssel über die PRTG Instanz zu speichern. Zudem beinhaltet das Profil auch verschiedene Einstellmöglichkeiten, zum Beispiel den Objekttyp für neu zu erstellende Geräte. Die ID kann unter Verwaltung > PRTG Profile ausgelesen werden.

  • group-id: Die PRTG Gruppen IDs dient zum Identifizieren der Gruppe im PRTG. Diese können im PRTG unter der Übersicht der jeweiligen Gruppe ausgelesen werden. Die ID kann auch eine Probe ID sein.

Daneben gibt es folgende Optionen, welche meist nicht zwingend benötigt werden:

  • recursion-depth: Gibt die Rekursionstiefe an. Wenn die Rekursionstiefe 0 ist, wird unendlich tief gegangen, ansonsten der jeweilige Wert. Mehr dazu im Kapitel SHD PRTG Addon

  • config: Gibt den Pfad zur Konfigurationsdatei inklusive Dateinamen an. Hier empfiehlt es sich absolute Pfade zu nutzen. Eine Konfigurationsdatei kann von mehreren Befehlen genutzt werden, solang sie nur Optionen beinhaltet, welche von allen Befehlen unterstützt werden. Für Befehle des PRTG Adapters sind, dass neben den Standardoptionen user, password und tenantId, die Oprionen level und objecttype. Diese Option wird immer benötigt, da Nutzername und Passwort zumindest in der Konfigurationsdatei stehen sollten und nicht im eigentlichen Befehl. Mehr dazu im Kapitel SHD PRTG Addon

  • user: Der i-doit Nutzername des Benutzers, der die PRTG Geräte importieren soll und kann. Diese Option sollte immer in einer sicheren Konfigurationsdatei stehen und nicht im Befehl selbst. Der Nutzername wird immer benötigt. Mehr dazu im Kapitel SHD PRTG Addon

  • passwort: Das i-doit Passwort des Benutzers, der die PRTG Geräte importieren soll und kann. Diese Option sollte immer in einer sicheren Konfigurationsdatei stehen und nicht im Befehl selbst. Das Passwort wird immer benötigt. Mehr dazu im Kapitel SHD PRTG Addon

  • tenantId: Gibt die ID des Tenants an. Bei einem Tentant kann diese Option auch weggelassen werden

Import durch Tags

Der Import durch Tags bildet den SHD PRTG Addon in der Kommandozeile ab. Der Befehl hat folgende Syntax:

php console.php prtg-import-by-tags [-u|--user USER] [-p|--password PASSWORD] [-i|--tenantId TENANTID] [-c|--config CONFIG] [--] <prtg-host-id> [<tags>...]

Der Befehl benötigt die folgenden Argumente in selber Reihenfolge:

  • prtg-host-id: Die PRTG-Host ID wird beim anlegen eines PRTG Profil im idoit automatisch erstellt. Diese wird verwendet, um Informationen, wie Host Adresse und API Schlüssel über die PRTG Instanz zu speichern. Zudem beinhaltet das Profil auch verschiedene Einstellmöglichkeiten, zum Beispiel den Objekttyp für neu zu erstellende Geräte. Die ID kann unter Verwaltung > PRTG Profile ausgelesen werden.

  • tags: Gibt die Tags an, welche alle Geräte besitzen müssen. Diese können im PRTG unter den Geräteeinstellungen der jeweiligen Geräts ausgelesen werden. Mehrere Tags können mit Leerzeichen angegeben werden. Sollte ein Tag ein Leerzeichen enthalten, wird er automatisch in mehrere Tags aufgeteilt, da PRTG keine Leerzeichen im Tag unterstützt.

Daneben gibt es folgende Optionen, welche meist nicht zwingend benötigt werden:

  • config: Gibt den Pfad zur Konfigurationsdatei inklusive Dateinamen an. Hier empfiehlt es sich absolute Pfade zu nutzen. Eine Konfigurationsdatei kann von mehreren Befehlen genutzt werden, solang sie nur Optionen beinhaltet, welche von allen Befehlen unterstützt werden. Für Befehle des PRTG Adapters sind, dass neben den Standardoptionen user, password und tenantId, die Oprionen level und objecttype. Diese Option wird immer benötigt, da Nutzername und Passwort zumindest in der Konfigurationsdatei stehen sollten und nicht im eigentlichen Befehl. Mehr dazu im Kapitel SHD PRTG Addon

  • user: Der i-doit Nutzername des Benutzers, der die PRTG Geräte importieren soll und kann. Diese Option sollte immer in einer sicheren Konfigurationsdatei stehen und nicht im Befehl selbst. Der Nutzername wird immer benötigt. Mehr dazu im Kapitel SHD PRTG Addon

  • passwort: Das i-doit Passwort des Benutzers, der die PRTG Geräte importieren soll und kann. Diese Option sollte immer in einer sicheren Konfigurationsdatei stehen und nicht im Befehl selbst. Das Passwort wird immer benötigt. Mehr dazu im Kapitel SHD PRTG Addon

  • tenantId: Gibt die ID des Tenants an. Bei einem Tentant kann diese Option auch weggelassen werden

Import durch PRTG Gruppen ID und Tags

Der Import durch die PRTG Gruppen ID bildet den SHD PRTG Addon in der Kommandozeile ab. Der Befehl hat folgende Syntax:

php console.php prtg-import-by-group-and-tags [-d|r|--recursion-depth RECURSION-DEPTH] [-u|--user USER] [-p|--password PASSWORD] [-i|--tenantId TENANTID] [-c|--config CONFIG] [--] <prtg-host-id> <group-id> [<tags>...]

Der Befehl benötigt die folgenden Argumente in selber Reihenfolge:

  • prtg-host-id: Die PRTG-Host ID wird beim anlegen eines PRTG Profil im i-doit automatisch erstellt. Diese wird verwendet, um Informationen, wie Host Adresse und API Schlüssel über die PRTG Instanz zu speichern. Zudem beinhaltet das Profil auch verschiedene Einstellmöglichkeiten, zum Beispiel den Objekttyp für neu zu erstellende Geräte. Die ID kann unter Verwaltung > PRTG Profile ausgelesen werden.

  • group-id: Die PRTG Gruppen IDs dient zum Identifizieren der Gruppe im PRTG. Diese können im PRTG unter der Übersicht der jeweiligen Gruppe ausgelesen werden. Die ID kann auch eine Probe ID sein.

  • tags: Gibt die Tags an, welche alle Geräte besitzen müssen. Diese können im PRTG unter den Geräteeinstellungen der jeweiligen Geräts ausgelesen werden. Mehrere Tags können mit Leerzeichen angegeben werden. Sollte ein Tag ein Leerzeichen enthalten, wird er automatisch in mehrere Tags aufgeteilt, da PRTG keine Leerzeichen im Tag unterstützt.

Daneben gibt es folgende Optionen, welche meist nicht zwingend benötigt werden:

  • level: Das Level gibt die Text-Interpretation an. Hier gibt es die Option 0 für keine, 1 für einfach und 2 für erweitert. Standardmäßig wird 2 verwendet. Mehr dazu im Kapitel SHD PRTG Addon

  • objecttype: Gibt den Objekttypen für neue zu erstellende Geräte an. Ein leerer Objekttyp sorgt dafür, dass keine Geräte neu erstellt werden. Mehr dazu im Kapitel SHD PRTG Addon

  • recursion-depth: Gibt die Rekursionstiefe an. Wenn die Rekursionstiefe 0 ist, wird unendlich tief gegangen, ansonsten der jeweilige Wert. Mehr dazu im Kapitel SHD PRTG Addon

  • config: Gibt den Pfad zur Konfigurationsdatei inklusive Dateinamen an. Hier empfiehlt es sich absolute Pfade zu nutzen. Eine Konfigurationsdatei kann von mehreren Befehlen genutzt werden, solang sie nur Optionen beinhaltet, welche von allen Befehlen unterstützt werden. Für Befehle des PRTG Adapters sind, dass neben den Standardoptionen user, password und tenantId, die Oprionen level und objecttype. Diese Option wird immer benötigt, da Nutzername und Passwort zumindest in der Konfigurationsdatei stehen sollten und nicht im eigentlichen Befehl. Mehr dazu im Kapitel SHD PRTG Addon

  • user: Der i-doit Nutzername des Benutzers, der die PRTG Geräte importieren soll und kann. Diese Option sollte immer in einer sicheren Konfigurationsdatei stehen und nicht im Befehl selbst. Der Nutzername wird immer benötigt. Mehr dazu im Kapitel SHD PRTG Addon

  • passwort: Das i-doit Passwort des Benutzers, der die PRTG Geräte importieren soll und kann. Diese Option sollte immer in einer sicheren Konfigurationsdatei stehen und nicht im Befehl selbst. Das Passwort wird immer benötigt. Mehr dazu im Kapitel SHD PRTG Addon

  • tenantId: Gibt die ID des Tenants an. Bei einem Tentant kann diese Option auch weggelassen werden.

Befehl und Cron Generator