Schnittstellen & API
Monitoring stellt die folgenden Schnittstellen zur Verwendung durch Drittsysteme bereit. Übergreifende Grundlagen — Konzepte, Erreichbarkeit und Authentifizierung der Fluxpunkt-Module — beschreibt der Artikel Schnittstellen & APIs.
Alle drei Schnittstellen sind ausschließlich lesend und liefern denselben, zwischengespeicherten Anlagen-Snapshot (Cache-Lebensdauer standardmäßig 30 Sekunden, konfigurierbar). Schreibende Zugriffe auf die STARFACE sind über keine der Schnittstellen möglich.
Schnittstellen im Überblick
| Schnittstelle | Typ | Authentifizierung |
|---|---|---|
| XML-RPC-Abfragen | XML-RPC (HTTPS) | angemeldeter STARFACE-Benutzer1 |
| SNMP | SNMPv1/v2c-Agent (UDP 161) | Community-String + IP-Filter |
| Datenendpunkt | TCP 6556 — CheckMk, XML, JSON | IP-Filter |
1 Ausnahme: die Abfrage isActiveDirectoryEnabled ist bewusst ohne Anmeldung
nutzbar — Details und Einordnung in der XML-RPC-Referenz.
SNMP-Agent und Datenendpunkt sind nur für die im Modul unter Einstellungen → Monitoring-Hosts eingetragenen IPv4-Adressen bzw. CIDR-Netze erreichbar. Das Modul öffnet die STARFACE-Firewall automatisch ausschließlich für diese Hosts und prüft jede Verbindung zusätzlich auf Anwendungsebene. Ohne (aktiven) Eintrag bleiben beide Dienste von außen geschlossen. Die XML-RPC-Abfragen laufen dagegen über den STARFACE-Webserver (HTTPS, 443/TCP) und sind von der Monitoring-Hosts-Liste unabhängig.
Voraussetzung für alle Schnittstellen ist eine aktive, lizenzierte Modulinstanz. Der SNMP-Agent erfordert zusätzlich die Edition Monitoring Pro.
Referenz
XML-RPC-Abfragen
registriert drei Abfragen an der XML-RPC-Schnittstelle der . Die Schnittstelle
SNMP
enthält einen eingebetteten, ausschließlich lesenden SNMPv1/v2c-Agenten ohne
Datenendpunkt
Der Datenendpunkt ist ein TCP-Dienst, der den Anlagen-Snapshot in drei Formaten ausliefert: