NetBox NetBox

Synchronisez votre IPAM, inventaire réseau et topologie de câblage

Le connecteur NetBox vous permet de synchroniser vos données de gestion d'infrastructure réseau directement depuis votre instance NetBox.

Objectif

Le connecteur NetBox permet de récupérer les informations suivantes :

  • Plan d'adressage IP (IPAM)
  • Inventaire des équipements réseau
  • Câblage et topologie

Prérequis

  • Instance NetBox accessible (version 3.0+)
  • Token API NetBox généré
  • Permissions de lecture sur les données IPAM et d'inventaire

Informations à fournir dans OverView

ChampDescription
Jeton APIToken d'authentification API NetBox
URL du serveurURL de votre instance NetBox (ex: https://netbox.example.com)

Paramètres

Ces paramètres sont facultatifs. Conservez leur valeur par défaut sauf besoin particulier.

ParamètreDescriptionDéfaut
Vérifier le SSLVérifier le certificat SSL lors de la connexion à l'APIDésactivé
Statuts à importerStatuts NetBox des équipements et machines virtuelles à importer. Valeurs par défaut : active, offline, planned, staged, failed, decommissioning, inventory (équipements uniquement), paused (machines virtuelles uniquement). Les statuts personnalisés définis dans NetBox sont également acceptés. Les équipements et machines virtuelles ayant un autre statut ne sont pas récupérés. Laisser vide pour importer tous les statutsVide (tous les statuts)

Configuration

Générer un token API NetBox

  1. Connectez-vous à votre instance NetBox.
  2. Cliquez sur votre icône de profil utilisateur dans le coin supérieur droit.
  3. Sélectionnez API Tokens dans le menu.
  4. Cliquez sur Add a token.
  5. Remplissez les détails du token :
    • Description : OverView Connector
    • Write enabled : Laissez décoché (lecture seule recommandée)
  6. Cliquez sur Create.
  7. Copiez immédiatement la valeur du token (elle n'apparaîtra qu'une seule fois). Le token aura le format nbt_... lors de l'utilisation de l'API v2.

Configurer le connecteur dans OverView

  1. Dans OverView, accédez à Data Sources Settings > Sources.
  2. Sélectionnez NetBox et cliquez sur Configure.
  3. Renseignez tous les champs requis :
  4. Cliquez sur Save Configuration.

Référence : NetBox REST API - Authentication

Permissions requises

Le token API doit disposer des permissions minimales suivantes :

  • Accès en lecture aux objets IPAM (Adresses IP, Préfixes, VLANs, etc.)
  • Accès en lecture à l'inventaire (Devices, Device types, Interfaces, etc.)
  • Accès en lecture au câblage (Cables, Power connections, etc.)
Alternative : import par fichiers via DropPoint

L'accès API décrit plus haut est la méthode recommandée pour ce connecteur. Lorsqu'il n'est pas disponible (réseau cloisonné, version ou licence sans API, export déjà produit par ailleurs), OverView accepte des exports de fichiers, à déposer dans le bucket dédié à NetBox.

Où déposer les fichiers ?

Bucket : s3://netbox/

Exemple : s3://netbox/export.csv

La procédure est décrite dans le guide OverView DropPoint : génération des credentials, configuration du client, puis envoi des fichiers depuis l'interface web OverView, l'AWS CLI ou un SDK. Les exemples y sont préremplis avec ce bucket lorsque vous suivez ce lien.