Création d'un groupe déquipements via l'API REST

Vous pouvez créer un grand nombre de groupes d'équipements complexes via l'API REST en référençant un fichier CSV exporté depuis une application tierce. Dans cette rubrique, nous présentons les méthodes permettant de créer un groupe d'équipements à la fois par le biais de l'explorateur d'API REST ExtraHop et d'un script Python.

Before you begin

  • Pour les capteurs et les machines virtuelles ECA, vous devez disposer d'une clé d'API valide pour apporter des modifications via l' API REST et suivre les procédures ci-dessous. (Voir Génération d'une clé d'API.)
  • Pour Reveal (x) 360, vous devez disposer d'informations d'identification d'API REST valides pour apporter des modifications via l'API REST et suivre les procédures ci-dessous. (Voir Création des informations dcredentidentification de l'API REST.)

Création d'un groupe déquipements via l'explorateur d'API REST

Important :L'explorateur d'API REST n'est pas disponible sur Reveal (x) 360.
  1. Dans un navigateur, accédez à l'explorateur d'API REST.
    L'URL est le nom d'hôte ou l'adresse IP de votre sonde ou console, suivi de /api/v1/explore/. Par exemple, si votre nom d'hôte est seattle-eda, l'URL est https://seattle-eda/api/v1/explore/.
  2. Cliquez Entrez la clé d'API puis collez ou saisissez votre clé d'API dans Clé d'API champ.
  3. Cliquez Autoriser puis cliquez sur Fermer.
  4. Cliquez Groupe d'appareils puis cliquez sur POST/groupes d'appareils.
  5. Cliquez Essayez-le.
    Le schéma JSON est automatiquement ajouté à la zone de texte des paramètres du corps.
  6. Dans le champ body, spécifiez les propriétés du groupe déquipements que vous souhaitez créer.
    Par exemple, le corps suivant crée un groupe déquipements qui inclut des blocs CIDR 192.168.0.0/26, 192.168.0.64/27, et 192.168.0.96/30:
    {
        "name": "New group",
        "description": "A newly created group",
        "filter": {
            "rules": [
                {
                    "field": "ipaddr",
                    "operand": "192.168.0.0/26",
                    "operator": "="
                },
                {
                    "field": "ipaddr",
                    "operand": "192.168.0.64/27",
                    "operator": "="
                },
                {
                    "field": "ipaddr",
                    "operand": "192.168.0.96/30",
                    "operator": "="
                }
            ],
            "operator": "or"
        }
    }
  7. Cliquez Envoyer une demande.

Récupérez et exécutez l'exemple de script Python

Le référentiel GitHub d'ExtraHop contient un exemple de script Python qui crée des groupes d'équipements en lisant les critères d'un fichier CSV répondant aux spécifications suivantes :

  1. Accédez au Référentiel GitHub d'exemples de code ExtraHop et téléchargez le create_device_groups/create_device_groups.py fichier sur votre machine locale.
  2. Dans le répertoire que vous avez copié create_device_groups.py pour créer un fichier CSV répondant aux spécifications suivantes :
    • Le fichier CSV ne doit pas contenir de ligne d'en-tête.
    • Chaque ligne du fichier CSV doit contenir les trois colonnes suivantes dans l'ordre indiqué :
      Nom du groupe d'appareils Descriptif adresse IP ou bloc CIDR
    • Chaque colonne située après les trois premières colonnes obligatoires doit spécifier une adresse IP ou un bloc CIDR pour le groupe déquipements.
      Remarque :Vous ne pouvez pas spécifier plus de 1 000 adresses IP ou blocs d'adresse CIDR pour un groupe déquipements.
    Remarque :Pour un exemple de fichier CSV compatible, consultez le fichier create_device_groups/device_group_list.csv dans le référentiel GitHub d' exemples de code ExtraHop.
  3. Dans un éditeur de texte, ouvrez le create_device_groups.py archivez et remplacez les variables de configuration par des informations provenant de votre environnement.
    • Pour les capteurs et les machines virtuelles ECA, spécifiez les variables de configuration suivantes :

      HÔTE: L'adresse IP ou le nom d'hôte de la sonde ou de la machine virtuelle ECA.

      CLÉ_API: La clé d'API.

      FICHIER_CSV: Le fichier qui contient la liste des groupes d'équipements.

    • Pour Reveal (x) 360, spécifiez les variables de configuration suivantes :

      HÔTE: Le nom d'hôte de l'API Reveal (x) 360. Ce nom d'hôte est affiché sur la page d'accès à l'API Reveal (x) 360 sous API Endpoint. Le nom d'hôte n'inclut pas /oauth/token.

      IDENTIFIANT: L'ID des informations d'identification de l'API REST Reveal (x) 360.

      SECRET: Le secret des informations d'identification de l'API REST Reveal (x) 360.

      FICHIER_CSV: Le fichier qui contient la liste des groupes d'équipements.

  4. Exécutez la commande suivante :
    python create_device_groups.py
    Remarque :Si le script renvoie un message d'erreur indiquant que la vérification du certificat SSL a échoué, assurez-vous que un certificat de confiance a été ajouté à votre sonde ou à votre console. Vous pouvez également ajouter le verify=False possibilité de contourner la vérification des certificats. Cependant, cette méthode n'est pas sûre et n'est pas recommandée. Le code suivant envoie une requête HTTP GET sans vérification de certificat :
    requests.get(url, headers=headers, verify=False)
Published 2023-11-07