API-Referenzhandbuch
Dieses Kaspersky Security Center OpenAPI-Referenzhandbuch soll Sie bei den folgenden Aufgaben unterstützen:
- Automatisierung und Individualisierung. Sie können dadurch Aufgaben automatisieren, die nicht manuell über die Verwaltungskonsole ausgeführt werden sollen. Sie können außerdem individuelle Lösungen implementieren, die von der Verwaltungskonsole momentan noch nicht unterstützt werden. Beispielsweise können Sie Kaspersky Security Center OpenAPI dazu verwenden, Scripte zu erstellen und auszuführen, die das Entwickeln und Pflegen einer Struktur von Administrationsgruppen vereinfachen.
- Individuelle Entwicklung. Sie können beispielsweise eine alternative MMC-basierte Verwaltungskonsole mit einem geringeren Funktionsumfang für Ihre Kunden entwickeln.
Verwenden Sie im OpenAPI-Referenzhandbuch das Suchfeld auf der rechten Seite des Bildschirms, um die von Ihnen benötigten Informationen zu finden.
Skriptbeispiele
Das OpenAPI-Referenzhandbuch enthält Beispiele für die in der folgenden Tabelle aufgeführten Python-Skripts. Diese Beispiele zeigen, wie Sie OpenAPI-Methoden aufrufen und verschiedene Aufgaben zum Schutz Ihres Netzwerks automatisch ausführen können, z. B. das Erstellen einer "primär/sekundär"-Hierarchie, das Ausführen von Aufgaben in Kaspersky Security Center oder das Zuweisen von Verteilungspunkten. Sie können die Beispiele unverändert ausführen oder Ihre eigenen Skripts basierend auf den Beispielen erstellen.
Um die OpenAPI-Methoden aufzurufen und Skripte auszuführen:
- Laden Sie das Archiv KlAkOAPI.tar.gz herunter. Dieses Archiv enthält das KlAkOAPI-Paket und Beispiele (Sie können diese aus dem Archiv oder dem OpenAPI-Referenzhandbuch kopieren). Das Archiv "KlAkOAPI.tar.gz" befindet sich ebenfalls im Installationsordner von Kaspersky Security Center.
- Installieren Sie das Paket KlAkOAPI aus dem Archiv KlAkOAPI.tar.gz auf einem Gerät mit installiertem Administrationsserver.
Sie können nur auf Geräten, auf denen der Administrationsserver und das Paket KlAkOAPI installiert sind, OpenAPI-Methoden aufrufen, Beispiele ausführen und eigene Skripte ausführen.
Benutzerszenarien und Beispiele für entsprechende Kaspersky Security Center OpenAPI-Methoden
Beispiel
Ziel des Beispiels
Szenario
Unter Verwendung der
KlAkParams
-Datenstruktur können Sie Daten extrahieren und verarbeiten. Das ist ein Beispiel für die Arbeit mit dieser Datenstruktur.Die Ausgabe des Beispiels kann auf verschiedene Weisen präsentiert werden. Sie können die Daten erhalten, um eine HTTP-Methode zu versenden, oder um Sie in Ihrem Code zu verwenden.
Sie können einen sekundären Administrationsserver hinzufügen und so eine Hierarchie vom Typ "primär/sekundär" festlegen. Alternativ können Sie den sekundären Administrationsserver von der Hierarchie trennen.
Erstellen der Gruppenhierarchie, basierend auf der Struktur der Active Directory-Einheit
Sie können eine Active Directory-Einheit abfragen und eine Hierarchie aus entdeckten Gerätegruppen erstellen.
Erstellen der Gruppenhierarchie, basierend auf der Struktur der gecachten Active Directory-Einheit
Sie können eine Hierarchie der Gruppen mit verwalteten Geräten erstellen, die auf der bereits im Voraus abgefragten Active Directory-Einheit basiert. Wenn neue Geräte erst nach der letzten Abfrage in der Active Directory erscheinen, werden diese der Gruppe nicht hinzugefügt, da sie nicht im Abfrageresultat gespeichert sind.
Netzwerklisten-Dateien mittels Verbindungs-Gateway auf das angegebene Gerät herunterladen
Unter Verwendung eines Verbindungs-Gateways können Sie sich mit dem Administrationsagenten des benötigten Geräts verbinden und anschließend die Datei mit der Netzwerkliste auf Ihr Gerät herunterladen.
Sie können sich mit dem primären Administrationsserver verbinden, von ihm einen erforderlichen Lizenzschlüssel herunterladen, und diesen Schlüssel an alle in der Hierarchie enthaltenen sekundären Administrationsserver weiterleiten.
Erstellen eines Berichts über gültige Benutzerberechtigungen
Sie können verschiedene Berichte erstellen. Unter anderem können Sie den Bericht über gültige Benutzerberechtigungen unter Verwendung dieses Beispiels erstellen. Dieser Bericht gibt die Berechtigungen eines Benutzers in Abhängigkeit seiner oder ihrer Gruppe und Rolle an.
Sie können den Bericht in den folgenden Formaten herunterladen: HTML, PDF oder Excel.
Unter Verwendung eines Verbindungs-Gateways können Sie sich mit dem Administrationsagenten des benötigten Geräts verbinden und anschließend die notwendige Aufgabe starten.
Erstellen von IP-Subnetzen, basierend auf Active Directory Sites and Services
Basierend auf der von Ihnen verwendeten Active Directory-Einheit können Sie ein IP-Subnetz erstellen.
Das Beispiel startet die Abfrage des angegebenen IP-Bereichs und löscht gefundene Subnetze, um Konflikte mit einem neuen Subnetz zu vermeiden. Führen Sie dieses Beispiel daher nicht in Netzwerken aus, für die das Vorhandensein von Subnetzen ein wichtiger Punkt ist.
Nach der Abfrage wechselt das Beispiel in das Active Directory, untersucht jedes darin enthaltene Gerät und erstellt das IP-Subnetz. Um dies zu tun, verwendet das Beispiel Masken und IP-Adressen von allen Geräten.
Registrieren von Verteilungspunkten für Geräte in einer Gruppe
Sie können verwalteten Geräten die Rolle eines Verteilungspunkts (früher bekannt als "Update-Agent") zuweisen.
Sie können mit Administrationsgruppen verschiedene Aktionen ausführen. Das Beispiel zeigt Folgendes:
- Eine ID der Root-Gruppe der "Verwalteten Geräte" abrufen
- Durch die Gruppenhierarchie bewegen
- Die vollständige, erweiterte Gruppenhierarchie, einschließlich ihrer Namen und Vierschachtelungen abrufen
Aufgaben durchzählen, Aufgabenstatistiken abfragen und Aufgaben ausführen
Die folgenden Informationen können Sie abfragen:
- Verlauf des Aufgabenprozesses
- Aktueller Aufgabenstatus
- Anzahl der Aufgaben mir unterschiedlichen Statuswerten
Sie können auch eine Aufgabe starten. Standardmäßig startet das Beispiel eine Aufgabe, nachdem es Statistiken ausgegeben hat.
Sie können eine Aufgabe erstellen. Geben Sie in dem Beispiel die folgenden Aufgabenparameter an:
- Typ
- Art der Ausführung
- Name
- Gerätegruppe, auf welche die Aufgabe angewendet wird
Standardmäßig erstellt das Beispiel eine Aufgabe des Typs "Nachricht anzeigen". Sie können diese Aufgabe für alle verwalteten Geräte des Administrationsservers ausführen. Bei Bedarf können Sie eigene Aufgabenparameter angeben.
Sie können eine Liste mit allen aktiven Lizenzschlüsseln für Kaspersky-Programme abrufen, die auf den verwalteten Geräten des Administrationsservers installiert sind. Die Liste enthält detaillierte Informationen über jeden Lizenzschlüssel, darunter Name, Typ oder Ablaufdatum.
Sie können ein Benutzerkonto zur weiteren Bearbeitung erstellen.
Auswählen des Benutzerkontos für den Start des Administrationsservers
Sie können eine Programmkategorie mit den benötigten Parametern erstellen.
Sie können die Klasse SrvView verwenden, um detaillierte Informationen vom Administrationsserver abzufragen. Unter Verwendung dieses Beispiels können Sie unter anderem eine Liste der Benutzer abrufen.
Anwendungen, die über OpenAPI mit Kaspersky Security Center interagieren
Einige Anwendungen können über OpenAPI mit Kaspersky Security Center interagieren. Zu solchen Anwendungen gehören beispielsweise Kaspersky Anti Targeted Attack Platform und Kaspersky Security for Virtualization. Dies kann auch ein von Ihnen entwickelte benutzerdefinierte Client-Anwendung auf Basis von OpenAPI sein.
Anwendungen, die über OpenAPI mit Kaspersky Security Center interagieren, verbinden sich mit dem Administrationsserver. Wenn Sie für die Verbindung mit dem Administrationsserver eine Allow-Liste mit IP-Adressen konfiguriert haben, fügen Sie die IP-Adressen von den Geräten hinzu, auf denen Anwendungen laufen, die Kaspersky Security Center OpenAPI verwenden. Weitere Informationen darüber, ob die von Ihnen verwendete Anwendung durch OpenAPI unterstützt wird, entnehmen Sie der Hilfe der entsprechenden Anwendung.