Aller au contenu principal

IP-Label Ekara Rest API

Contenu du Pack​

Modèles​

Le Pack Centreon IP-Label Ekara Rest API apporte 1 modèle d'hôte :

  • App-Monitoring-Iplabel-Ekara-Restapi-custom

Il apporte les modèles de service suivants :

AliasModèle de serviceDescriptionDéfaut
IncidentsApp-Monitoring-Iplabel-Ekara-Incidents-RestapiContrôle les incidents IP-Label EkaraX
Scenario-StatusApp-Monitoring-Iplabel-Ekara-Scenario-Status-RestapiContrôle les scénarios IP-Label EkaraX

Règles de découverte​

Le Pack Centreon IP-Label Ekara Rest API inclut un fournisseur de découverte d'Hôtes nommé IP-Label Ekara. Celui-ci permet de découvrir l'ensemble des scenarios Ekara d'une instance donnée et d'ajouter ceux-ci en tant qu'hôtes dans Centreon.

Vous trouverez plus d'informations sur la découverte d'Hôtes et son fonctionnement dans la documentation du module: Découverte des hôtes

Métriques & statuts collectés​

MétriqueUnité
ekara.incidents.current.total.countcount
ekara.incident.duration.secondss
incident-severitystring
incident-statusstring
trigger-statusstring

Prérequis​

  • Un compte de service disposant des droits en lecture est requis pour l'accès à l'API Rest Ekara.
  • Le collecteur Centreon en charge de la supervision de ces ressources doit être en mesure de pouvoir joindre l'API Ekara sur Internet sur le port TCP/443.

Installation​

  1. Installer le Plugin Centreon sur tous les collecteurs Centreon devant superviser des ressources IP-Label Ekara :

     yum install centreon-plugin-Applications-Monitoring-Iplabel-Ekara-Restapi

  2. Sur l'interface Web de Centreon, installer le connecteur de supervision IP-Label Ekara Rest API depuis la page Configuration > Packs de plugins.

Configuration​

Hôte​

  • Ajoutez un hôte à Centreon depuis la page Configuration > Hôtes.
  • Complétez les champs Nom, Alias et remplissez le champ Adresse IP/DNS avec l'adresse 127.0.0.1.
  • Appliquez le Modèle d'Hôte App-Monitoring-Iplabel-Ekara-Restapi-custom.
  • Une fois le modèle appliqué, les Macros ci-dessous indiquées comme requises (Obligatoire) doivent être renseignées.
ObligatoireMacroDescription
EKARAAPIEXTRAOPTIONSOptions supplémentaires à ajouter à l'ensemble des commandes de l'hôte (ex: --verbose)
XEKARAAPIHOSTNAMEapi.ekara.ip-label.net
XEKARAAPIUSERNAME
XEKARAAPIPASSWORD
XEKARAAPIPORT443
XEKARAAPIPROTOhttps
FILTERID
FILTERNAME
PROXYURL

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_monitoring_iplabel_ekara_restapi.pl \
    --plugin=apps::monitoring::iplabel::ekara::restapi::plugin \
    --mode=scenarios \
    --hostname='api.ekara.ip-label.net' \
    --api-username='johndoe@company.com' \
    --api-password='MyPassw0rd' \
    --port='443' \
    --proto='https' \
    --proxyurl='' \
    --timeframe='900' \
    --filter-name='MyScenario' \
    --filter-id='' \
    --verbose

La commande devrait retourner un message de sortie similaire à :

OK: Scenario 'MyScenario': status: Success (1), availability: 100% | 'MyScenario#scenario.availability.percentage'=100%;;;0;100
Scenario 'MyScenario':
    status: Success (1), availability: 100%

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_monitoring_iplabel_ekara_restapi.pl \
    --plugin=apps::monitoring::iplabel::ekara::restapi::plugin \
    --mode=scenarios \
    --help

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

/usr/lib/centreon/plugins//centreon_monitoring_iplabel_ekara_restapi.pl \
    --plugin=apps::monitoring::iplabel::ekara::restapi::plugin \
    --list-mode

Diagnostic des erreurs communes​

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