Guide de référence de l'API

Ce guide de référence de Kaspersky Security Center OpenAPI est conçu pour vous aider dans les tâches suivantes :

Dans le guide de référence OpenAPI, vous pouvez utiliser le champ de recherche situé dans la partie droite de l'écran pour localiser les informations dont vous avez besoin.

unloc_icon_API_open GUIDE DE RÉFÉRENCE OPENAPI

Exemples de scripts

Le guide de référence OpenAPI contient des exemples de scripts Python répertoriés dans le tableau ci-dessous. Les exemples montrent comment vous pouvez appeler les méthodes OpenAPI et accomplir automatiquement différentes tâches pour protéger votre réseau, par exemple, créer une hiérarchie " principale/secondaire ", exécuter des tâches dans Kaspersky Security Center ou affecter des points de distribution. Vous pouvez exécuter les exemples tels quels ou créer vos propres scripts sur la base des exemples.

Pour appeler les méthodes OpenAPI et exécuter des scripts, procédez comme suit :

  1. Téléchargez l'archive KlAkOAPI.tar.gz. Cette archive comprend le paquet KlAkOAPI et des exemples (vous pouvez les copier à partir de l'archive ou du guide de référence OpenAPI). L'archive KlAkOAPI.tar.gz se trouve également dans le dossier d'installation de Kaspersky Security Center.
  2. Installez le paquet KlAkOAPI depuis l'archive KlAkOAPI.tar.gz sur l'appareil sur lequel le Serveur d'administration est installé.

    Vous pouvez appeler les méthodes OpenAPI, exécuter les exemples et vos propres scripts uniquement sur les appareils sur lesquels le Serveur d'administration et le paquet KlAkOAPI sont installés.

    Correspondance entre les scénarios utilisateur et les exemples de méthodes de Kaspersky Security Center OpenAPI

    Exemple

    Objectif de l'exemple

    Scénario

    Journal KlAkParams

    Vous pouvez extraire et traiter les données en utilisant la structure de données KlAkParams. L'exemple montre comment utiliser cette structure de données.

    L'exemple de sortie peut être présent de différentes manières. Vous pouvez obtenir les données pour envoyer une méthode HTTP ou les utiliser dans votre code.

    Surveillance et rapports

    Créer et supprimer une hiérarchie primaire/secondaire

    Vous pouvez ajouter un Serveur d'administration secondaire et établir une hiérarchie de type " principal/secondaire ". Vous pouvez également déconnecter le Serveur d'administration secondaire de la hiérarchie.

    Créer la hiérarchie de groupe avec une structure basée sur l'unité Active Directory

    Vous pouvez sonder l'unité Active Directory et former une hiérarchie de groupes d'appareil découverts.

    Création des groupes d'administration

    Créer la hiérarchie de groupe avec une structure basée sur l'unité Active Directory mise en cache

    Vous pouvez former une hiérarchie des groupes d'appareils administrés en fonction de l'unité Active Directory sondé précédemment. Si de nouveaux appareils apparaissent dans Active Directory après le dernier sondage, ils ne sont pas ajoutés au groupe parce qu'ils ne figurent pas dans les résultats enregistrés du sondage.

    Création des groupes d'administration

    Télécharger les fichiers avec la liste des réseaux via la passerelle de connexion vers l'appareil spécifié

    Vous pouvez vous connecter à l'Agent d'administration sur l'appareil nécessaire à l'aide d'une passerelle de connexion, puis téléchargez un fichier contenant la liste des réseaux sur votre appareil.

    Réglage des points de distribution et des passerelles de connexion

    Installez une clé de licence stockée dans le stockage principal du Serveur d'administration sur les Serveurs d'administration secondaires

    Vous pouvez vous connecter au Serveur d'administration primaire, télécharger une clé de licence requise à partir de celui-ci et transmettre cette clé à tous les Serveurs d'administration secondaires inclus dans une hiérarchie.

    Licence des applications administrées

    Créer un rapport des droits d'utilisateur effectifs

    Vous pouvez créer les rapports différents. Par exemple, vous pouvez générer le rapport des droits d'utilisateur effectifs en utilisant cet exemple. Ce rapport décrit les droits dont dispose un utilisateur, en fonction de son groupe et de son rôle.

    Vous pouvez télécharger le rapport au format HTML, PDF ou Excel.

    Génération et affichage d'un rapport

    Lancer une tâche pour un appareil

    Vous pouvez vous connecter à l'Agent d'administration sur l'appareil nécessaire à l'aide d'une passerelle de connexion, puis exécuter la tâche nécessaire.

    Lancer une tâche manuellement

    Créer des sous-réseaux IP reposant sur Active Directory Site and Services

    Vous pouvez créer un sous-réseau IP basé sur l'unité Active Directory que vous utilisez.

    L'exemple lance le sondage de la plage d'adresses IP spécifiée et supprime les sous-réseaux découverts pour éviter leur conflit avec un nouveau sous-réseau. Par conséquent, n'exécutez pas cet exemple sur le réseau où il est important d'enregistrer les sous-réseaux.

    Après le sondage, l'exemple fait référence à Active Directory, examine chaque appareil qu'il contient et crée le sous-réseau IP. Pour ce faire, l'exemple utilise les masques et les adresses IP de tous les appareils.

    Configuration de la protection réseau

    Enregistrer les points de distribution pour les appareils d'un groupe

    Vous pouvez affecter des appareils administrés en tant que points de distribution (anciennement appelés agents de mise à jour).

    Mise à jour des bases de données et des applications Kaspersky

    Énumérer tous les groupes

    Vous pouvez effectuer diverses actions avec les groupes d'administration : L'exemple montre comment procéder :

    • Obtenir un identifiant du groupe racine "Appareils administrés"
    • Se déplacer dans la hiérarchie du groupe
    • Récupérer la hiérarchie complète et développée des groupes, ainsi que leurs noms et leur imbrication

    Configuration du Serveur d'administration

    Énumérer les tâches, interroger les statistiques des tâches et exécuter une tâche

    Vous pouvez découvrir les informations suivantes :

    • Historique de progression des tâches
    • État actuel de la tâche
    • Nombre de tâches dans différents états

    Vous pouvez également exécuter une tâche. Par défaut, l'exemple exécute une tâche après avoir généré des statistiques.

    Suivi et affichage des comptes rendus d'activité des tâches

    Créer et exécuter une tâche

    Vous pouvez créer une tâche. Spécifiez dans l'exemple les paramètres suivants de la tâche :

    • Type
    • Méthode d'exécution
    • Nom
    • Groupe d'appareils pour lequel la tâche sera utilisée

    Par défaut, l'exemple crée une tâche avec le type "Afficher un message". Vous pouvez exécuter cette tâche pour tous les appareils administrés du Serveur d'administration. Si nécessaire, vous pouvez spécifier vos propres paramètres de la tâche.

    Création d'une tâche

    Énumérer les clés de licence

    Vous pouvez obtenir une liste de toutes les clés de licence actives pour les applications Kaspersky installées sur les appareils administrés du Serveur d'administration. La liste contient des données détaillées sur chaque clé de licence, telles que le nom, le type ou la date d'expiration.

    Consultation des informations sur les clés de licence utilisées

    Créer et trouver un utilisateur interne

    Vous pouvez créer un compte pour les travaux ultérieurs.

    Sélection du compte utilisateur pour lancer le Serveur d'administration

    Créer une catégorie personnalisée

    Vous pouvez créer la catégorie d'application avec les paramètres nécessaires.

    Création d'une catégorie d'applications enrichie manuellement

    Énumérer les utilisateurs à l'aide de SrvView

    Vous pouvez utiliser la catégorie SrvView pour demander des informations détaillées depuis le Serveur d'administration. Par exemple, vous pouvez obtenir une liste d'utilisateurs en utilisant cet exemple.

    Administration des comptes utilisateurs

Applications interagissant avec Kaspersky Security Center via OpenAPI

Certaines applications interagissent avec Kaspersky Security Center via OpenAPI. De telles applications incluent, par exemple, Kaspersky Anti Targeted Attack Platform ou Kaspersky Security for Virtualization. Il peut également s'agir d'une application cliente personnalisée que vous avez développée sur la base d'OpenAPI.

Les applications interagissant avec Kaspersky Security Center via OpenAPI se connectent au Serveur d'administration. Si vous avez configuré une liste d'autorisations d'adresses IP pour la connexion au Serveur d'administration, ajoutez les adresses IP des appareils sur lesquels sont installées les applications utilisant Kaspersky Security Center OpenAPI. Pour savoir si l'application que vous utilisez fonctionne par OpenAPI, consultez l'Aide de cette application.

Haut de page