Table of Contents
Introduction
NetBox est un outil de modélisation des ressources d’infrastructure (IRM) open source, conçu pour gérer et documenter les réseaux et les infrastructures de datacenter. Il est souvent utilisé comme « source de vérité » pour automatiser la gestion des réseaux. Dans cet article, nous allons détailler l’installation rapide de NetBox avec Docker et l’importation de définitions de types d’appareils, en incluant la génération d’une clé d’API nécessaire pour cette importation.
Prérequis
Avant de commencer l’installation de NetBox, assurez-vous que votre environnement répond aux exigences suivantes :
- Docker : Docker et Docker Compose doivent être installés. Vous pouvez les installer en suivant les instructions disponibles sur le site officiel de Docker.
- Git : Git est nécessaire pour cloner les dépôts.
Étape 1 : Installation de NetBox avec Docker
1.1 Cloner le dépôt NetBox Docker
Commencez par cloner le dépôt officiel de NetBox Docker :
git clone -b release https://github.com/netbox-community/netbox-docker.git
cd netbox-docker
1.2 Configurer les ports (optionnel)
Pour configurer un port spécifique pour accéder à NetBox, créez un fichier docker-compose.override.yml
:
nano docker-compose.override.yml
Ajoutez-y le contenu suivant :
version: '3.4'
services:
netbox:
ports:
- "8000:8080"
1.3 Démarrer NetBox
Téléchargez les images Docker et démarrez les conteneurs :
docker compose pull
docker compose up -d
NetBox sera accessible via http://localhost:8000
.
1.4 Créer un utilisateur admin
Pour accéder à l’interface administrateur, créez un utilisateur admin :
docker compose exec netbox /opt/netbox/netbox/manage.py createsuperuser
Étape 2 : Générer une clé d’API dans NetBox
Pour importer des définitions de types d’appareils, vous aurez besoin d’une clé d’API. Voici comment la générer :
2.1 Accéder au profil utilisateur
- Connectez-vous à votre instance NetBox.
- Cliquez sur votre nom d’utilisateur en haut à droite et sélectionnez Profile dans le menu déroulant.
2.2 Générer un token d’API
- Dans la section API Tokens de votre profil, cliquez sur Add a token.
- Donnez un nom au token, comme « Import de types d’appareils ».
- Spécifiez une date d’expiration si nécessaire.
- Cliquez sur Save pour générer le token. Attention : Ce token ne sera affiché qu’une seule fois. Copiez-le immédiatement pour l’utiliser dans vos scripts d’importation.
Étape 3 : Importer les Définitions de Types d’Appareils
3.1 Cloner le dépôt de la bibliothèque de types d’appareils
Le dépôt netbox-community/devicetype-library
contient une vaste collection de types d’appareils courants. Clonez-le :
git clone https://github.com/netbox-community/devicetype-library.git
cd devicetype-library
3.2 Utiliser le script d’importation
Pour automatiser l’importation des types d’appareils :
- Cloner le dépôt du script d’importation :
git clone https://github.com/netbox-community/Device-Type-Library-Import.git
cd Device-Type-Library-Import
- Configurer l’environnement :
python3 -m venv venv
source venv/bin/activate
pip install -r requirements.txt
- Configurer les variables d’environnement : Copiez le fichier
.env.example
et éditez-le avec l’URL de votre instance NetBox et le token d’API généré précédemment :
cp .env.example .env
vim .env
- Exécuter le script d’importation :
./nb-dt-import.py
Ce script importera les définitions de types d’appareils dans NetBox.
Conclusion
En suivant ces étapes, vous aurez installé NetBox avec Docker, généré une clé d’API, et importé une bibliothèque complète de types d’appareils. Ces outils simplifient la gestion et la documentation de votre infrastructure réseau, en centralisant toutes les informations nécessaires pour une gestion efficace.
Pour plus d’informations, consultez :