EV Observe - Utiliser les modèles de service Global-Api-Value et Global-Api-Status

Modifié le 27/09/2022 17:56

Les modèles de service Global-Api-Value et Global-Api-Status supervisent, de façon générique, n'importe quelle API au format REST JSON. Ils permettent de traiter respectivement des retours numérique et textuels et de les comparer à des seuils ou des valeurs attendues.

Une authentification peut être réalisée avec l'appel d'un EndPoint différent du EndPoint final.

Remarques

  • Les 2 modèles de services supportent uniquement les API au format REST JSON.
  • Ils supportent uniquement les protocoles d’authentification Sans authentification, OAuth, Basic.
  • Un EndPoint désigne la fin l’URL qui peut être appelée avec des paramètres via les méthodes GET (lecture) et POST (écriture).

exemple  http://myservice.com/v3/token - appel de l'API : http://myservice.com/v3/jobs

  • URL = http://myservice.com/v3
  • EndPoint d’authentification = /token
  • EndPoint = /jobs

Procédure : Comment utiliser les modèles de service

1. Allez sur l'application web.

2. Créez un nouveau modèle de service.

  • Allez sur le menu Configuration > Services > Liste.
  • Cliquez sur + Ajouter dans l'onglet Mode : Box.

3. Renseignez les informations ci-dessous.

Onglet Informations générales
       Global-Api-Value-Status configuration.png

  • Modèle de service : Sélectionnez le modèle souhaité Global-Api-Value ou Global-Api-Status.
  • Nom du service : Saisissez le nom du nouveau service unitaire à créer, correspondant au nom de l'événement à capter.

    exemple  Link Down

     

Onglet Disponibilité et contrôles
         Global-Api-Value-Status configuration - Availability and checks tab.png

  • Renseignez les informations d'authentification si l’API demande une authentification via un EndPoint différent du EndPoint final (authentification OAuth ou pour toute API qui demande un token, un visa ou un autre élément similaire pour faire l’appel).
      Open url.png voir Cas d'utilisation

4. Enregistrez le nouveau modèle de service via Valider.

Cas d'utilisation

Appel de l'API REST Veeam Backup pour Microsoft 365

  • Ces cas d'utilisation vous permettent de configurer les modèles de service Global-Api-Value et Global-Api-Status dans le cadre de l'utilisation de l'API REST Veeam Backup pour Microsoft 365.
  • L'API REST Veeam Backup pour Microsoft 365 est basée sur une authentification OAuth.

Configuration pour appeler le EndPoint Jobs

     Open url.png voir Documentation de l'API REST Veeam Backup

Pour faire les appels au EndPoint Jobs, un token doit être fourni. Celui-ci est collecté lors de l’appel au EndPoint d’authentification et est mis en cache avec une durée de validité passée en paramètre. Il est récupéré via le EndPoint d’authentification.

          Use case API Veeam - Call endpoint jobs.png

Configuration du EndPoint d’authentification

  • URL = https://abc.tech.local:4443/v5
  • Identifiant = xxxx
  • Mot de passe = yyyy
  • EndPoint d’authentification = /token
  • Méthode du EndPoint d’authentification = POST
  • Header d’authentification = Content-Type: application/x-www-form-urlencoded
  • Body d’authentication = grant_type=password&username=%login%&password=%password%
    • %login% et %password% permettent de récuperer la valeur du champ Identifiant de EV Observe et de bénéficier de la gestion des comptes de supervision.
    • Attention : Ne remplacez pas le mot de passe dans grant_type=password. Il permet d'indiquer le type d’authentification à l’API (choix du developpeur de l’API).
  • Champ d’identification : access_token
    • Correspond au nom du champ qui retourne la valeur nécessaire pour l’appel suivant.
    • Seul le nom du champ est renseigné car il est directement à la racine de la réponse, i.e. le niveau 1 du Json.
  • Validité du cache = 60

Configuration pour récupérer le dernier statut des jobs de sauvegarde

     Open url.png voir Documentation de l'API REST Veeam Backup

          Use case API Veeam - Retrieve last status #1.png

Configuration du EndPoint d’authentification

  • EndPoint = /Jobs
  • Méthode = GET
  • Header = Authorization: Bearer %auth%
    • %auth% est automatiquement remplacé par la valeur récupérée dans le champ Champ d’identification dans l’appel précédent.

L'API retourne un tableau contenant des informations pour chaque job de sauvegarde. Le modèle de service analyse chaque élément de ce tableau à partir de la configuration ci-dessous.

  • Arborescence = {vide}
    • Permet de se positionner au début du tableau. Dans l’exemple, l’API retourne directement le tableau, donc la valeur est {vide}.
  • Filtre = name
    • Correspond au nom du job de sauvegarde.
    • Le filtre (listes blanche et noire) s'effectue sur les noms des jobs.
  • Valeurs = lastStatus
    • Il s’agit du champ pour lequel la valeur retournée est prise en compte pour l’analyse (seuils ou texte).

Configuration pour obtenir le dernier statut dans le service

  • L'API retourne un tableau contenant des informations sur les 3 dernières exécutions de chaque job de sauvegarde. Le modèle de service analyse chaque élément de ce tableau à partir de la configuration ci-dessous.
  • Note : Dans ces exemples, les valeurs identifient la position dans le tableau.
     
Retour de l'API Configuration du EndPoint d’authentification
Use case API Veeam - Retrieve last status #2.png
  • Arborescence = tableau
    • Permet de se positionner au niveau de tableau qui devient le nouveau référentiel d’analyse.
  • Filtre = Informations>name
    • Le nom du job (name) se trouve au niveau Informations du référentiel.
  • Valeur = Result>lastStatus
    • Le statut du job (lastStatus) se trouve au niveau Result du référentiel.
Use case API Veeam - Retrieve last status #3.png
  • Arborescence = {vide}
    • Permet de se positionner au début du tableau.
  • Filtre = name
    • Correspond au nom du job de sauvegarde.
    • Le filtre (listes blanche et noire) s'effectue sur les noms des jobs.
  • Valeur = lastresults>2>executionstatut
    • lastresults : Permet de se positionner sur le niveau lastresults du tableau.
    • 2 : Permet de récupérer la troisième valeur (un tableau débute toujours à 0).
    • Récupérer la valeur associée à executionstatut.

ou

  • Valeur = lastresults>-1>executionstatut
    • Permet de récuperer la dernière valeur du tableau (-2 pour l’avant dernière)
Use case API Veeam - Retrieve last status #4.png
  • Arborescence = {vide}
    • Permet de se positionner au début du tableau.
  • Filtre = name
    • Correspond au nom du job de sauvegarde.
    • Le filtre (listes blanche et noire) s'effectue sur les noms des jobs.
  • Valeur = lastresults>2>1
    • lastresults : Permet de se positionner sur le niveau lastresults du tableau.
    • 2 : Permet de récupérer la troisième valeur (un tableau débute toujours à 0) et de se positionner sur un nouveau tableau.
    • 1 : Permet de récupérer la deuxième valeur du tableau précédent.

Configuration en utilisant un masque de valeurs

  • L'API retourne un tableau contenant la température pour chaque ventilateur d'un équipement. Le modèle de service analyse chaque élément de ce tableau à partir de la configuration ci-dessous.
  • Un masque de valeurs est utilisé pour obtenir la température des ventilateurs sous forme d'une valeur numérique.
Retour de l'API Configuration du EndPoint d’authentification
Use case API Veeam - Retrieve equipment temperature.png
  • Arborescence = {vide}
    • Permet de se positionner au début du tableau.
  • Filtre = name
    • Correspond au nom du ventilateur.
    • Le filtre (listes blanche et noire) s'effectue sur les noms des ventilateurs.
  • Valeur = Temperature
    • Permet de récupérer la température sous forme de texte (et non de chiffres) avec le caractère C (Celsius).
    • Pour conserver uniquement la valeur numérique, il faut utiliser un masque de valeurs : [0-9]+.
Tags :
Powered by XWiki © EasyVista 2022