Aller au contenu principal

Freebox RestAPI

Contenu du Pack​

Modèles​

Le connecteur de supervision Centreon Freebox apporte un modèle d'hôte :

  • Net-Freebox-Restapi-custom

Il apporte les modèles de service suivants :

AliasModèle de serviceDescriptionDéfaut
Dsl-UsageNet-Freebox-Dsl-Usage-RESTAPIContrôle permettant de vérifier l'utilisation DSLX
Net-UsageNet-Freebox-Net-Usage-RESTAPIContrôle permettant de vérifier l'utilisation réseauX
SystemNet-Freebox-System-RESTAPIContrôle permettant de vérifier l'utilisation systèmeX

Métriques & statuts collectés​

MétriqueUnité
rate-downb/s
rate-upb/s
snr-downdB
snr-updB

Prérequis​

Il est nécessaire au préalable d'autoriser le client et choisir un app_id et obtenir un token.

  • Appelez la terminaison API permettant d'autoriser une application, remplacez les valeurs par celles souhaitées:

curl http://<freebox_ip>/api/v4/login/authorize -d '{"app_id":"centreon","app_name":"centreon","app_version":"3.0","device_name":"Freebox"}'

  • Validez depuis l'écran de la freebox et récupérez le token
  • Ouvrez la page suivante http://<freebox_ip>/api/v4/login/authorize/<app_id>
  • Vérifiez que l'application est correcte et possède les bons droits

Conservez précieusement votre app_id et le token car ils seront nécessaires durant la configuration de l'hôte.

Installation​

Pack de supervision​

Si la plateforme est configurée avec une licence online, l'installation d'un paquet n'est pas requise pour voir apparaître le pack dans le menu Configuration > Gestionnaire de connecteurs de supervision.

Au contraire, si la plateforme utilise une licence offline, installez le paquet sur le serveur central via la commande correspondant au gestionnaire de paquets associé à sa distribution :

dnf install centreon-pack-network-freebox-restapi

Quel que soit le type de la licence (online ou offline), installez le Pack Freebox depuis l'interface web et le menu Configuration > Gestionnaire de connecteurs de supervision.

Plugin​

À partir de Centreon 22.04, il est possible de demander le déploiement automatique du plugin lors de l'utilisation d'un pack.

Plus d'informations dans la section Installer le plugin.

Utilisez les commandes ci-dessous en fonction du gestionnaire de paquets de votre système d'exploitation :

dnf install centreon-plugin-Network-Freebox-Restapi

Configuration​

Hôte​

  • Ajoutez un hôte à Centreon depuis la page Configuration > Hôtes.
  • Complétez les champs Nom, Alias & IP Address/DNS correspondant à votre serveur Freebox.
  • Appliquez le modèle d'hôte Net-Freebox-Restapi-custom.
  • Une fois le modèle appliqué, les macros ci-dessous indiquées comme requises (Obligatoire) doivent être renseignées.
ObligatoireMacroDescription
FREEBOXAPPIDL'identifiant d'application défini lors du déroulé des prérequis
FREEBOXAPPTOKENLe token obtenu précédemment
FREEBOXEXTRAOPTIONSOptions supplémentaires à ajouter à l'ensemble des commandes de l'hôte (ex: --verbose)

Comment puis-je tester le plugin et que signifient les options des commandes ?​

Une fois le plugin installé, vous pouvez tester celui-ci directement en ligne de commande depuis votre collecteur Centreon en vous connectant avec l'utilisateur centreon-engine (su - centreon-engine) :

/usr/lib/centreon/plugins//centreon_freebox_restapi.pl \
--plugin=network::freebox::restapi::plugin \
--mode=system \
--hostname='10.0.0.1' \
--freebox-app-id='' \
--freebox-app-token='' \
--warning-wifi-status='%{status} =~ /bad_param/i' \
--critical-wifi-status='%{status} =~ /failed/i' \
--warning-disk-status='' \
--critical-disk-status='%{status} =~ /error/i' \
--warning-temperature-cpum='' \
--critical-temperature-cpum='' \
--warning-temperature-cpub='' \
--critical-temperature-cpub='' \
--warning-temperature-switch='' \
--critical-temperature-switch='' \
--warning-fan-speed='' \
--critical-fan-speed='' \
--verbose \
--use-new-perfdata

La commande devrait retourner un message de sortie similaire à :

OK: Temperature cpum : %s C Temperature cpub : %s C Temperature switch : %s C fan speed : %s rpm   | 

La liste de toutes les options complémentaires et leur signification peut être affichée en ajoutant le paramètre --help à la commande :

/usr/lib/centreon/plugins//centreon_freebox_restapi.pl \
--plugin=network::freebox::restapi::plugin \
--mode=system \
--help

Tous les modes disponibles peuvent être affichés en ajoutant le paramètre --list-mode à la commande :

/usr/lib/centreon/plugins//centreon_freebox_restapi.pl \
--plugin=network::freebox::restapi::plugin \
--list-mode

Diagnostic des erreurs communes​

Rendez-vous sur la documentation dédiée des plugins basés sur HTTP/API.