LibreNMS LibreNMS

Configurez le connecteur LibreNMS pour paramétrer l'accès API et récupérer les informations

Objectif

Le but de ce document est de fournir une procédure pour mettre en place l'API LibreNMS et générer le jeton API (X-Auth-Token) requis pour récupérer les informations de surveillance réseau depuis LibreNMS.

À l'issue de cette procédure, vous serez en mesure de fournir :

  • IP/URL du serveur
  • Jeton API (X-Auth-Token)

Création des identifiants d'accès

  1. Connectez-vous à la console LibreNMS avec un utilisateur ayant les droits administrateur.
  2. Accédez à Settings > API access.
  3. Cliquez sur Create API access token.
  4. Sélectionnez l'utilisateur pour lequel générer le jeton.
  5. Copiez le jeton API généré (X-Auth-Token).
  6. Stockez le jeton de manière sécurisée pour l'utiliser dans la configuration OverView.
  7. Le jeton peut également être récupéré via un QR Code s'il est disponible dans votre version.

Informations à fournir dans OverView

ChampDescription
Jeton APIJeton d'authentification API LibreNMS
URL du serveurURL de base du serveur LibreNMS

Étapes de configuration

1. Configuration du compte utilisateur

  1. Assurez-vous que vous disposez d'un compte utilisateur avec les permissions appropriées
  2. Le compte doit avoir accès en lecture aux informations des appareils
  3. Vérifiez que l'utilisateur peut accéder à la section des paramètres API

2. Génération du jeton API

  1. Accédez à Settings > API access
  2. Cliquez sur Create API access token
  3. Sélectionnez l'utilisateur et créez le jeton
  4. Copiez le jeton API généré immédiatement
  5. Stockez le jeton de manière sécurisée pour la configuration OverView

3. Configurer dans OverView

  1. Dans OverView, accédez à Data Sources Settings > Sources.
  2. Sélectionnez LibreNMS et cliquez sur Configure.
  3. Entrez l'URL du serveur LibreNMS (nom d'hôte ou adresse IP).
  4. Collez le jeton API dans le champ d'authentification.
  5. Utilisez l'en-tête X-Auth-Token pour l'authentification.
  6. Cliquez sur Save Configuration.

Authentification

Le connecteur LibreNMS utilise l'authentification par jeton API avec l'en-tête X-Auth-Token.

Test de l'accès API

Vous pouvez tester le jeton API en utilisant curl :

curl -H "X-Auth-Token: YOUR_TOKEN" "https://YOUR_SERVER/api/v0/devices"

Recommandations de sécurité

  • Utilisez HTTPS pour la communication API
  • Faites tourner régulièrement les jetons API
  • Surveillez les journaux d'accès API
  • Limitez l'accès API aux plages d'adresses IP nécessaires
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é à LibreNMS.

Où déposer les fichiers ?

Bucket : s3://librenms/

Exemple : s3://librenms/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.

Documentation officielle

Pour plus d'informations, consultez la Documentation de l'API LibreNMS