Cette documentation vous guide pas à pas pour générer une clé API dans GLPI (Gestionnaire Libre de Parc Informatique).

Connectez-vous à l'interface web de votre instance GLPI avec un compte ayant les droits d'administration.

1. Dans le menu principal, cliquez sur Configuration → Générale.
2. Allez dans l’onglet API.
3. Séléctionner « Oui » pour Activer l’API REST.
4. Cliquez sur Sauvegarder.

Si vous n’avez pas encore d’utilisateur pour l’API :

1. Dans le menu principal, cliquez sur Configuration → Générale.

2. Allez dans l’onglet API.

3. Cliquez sur Ajouter un client de l'API.

   

4. Donnez un nom au client API

5. Séléctionner « Oui » pour Actif.

6. Ajouter l'IP du serveur Esia dans Début de plage d'adresse IPv4 et Fin de plage d'adresse IPv4 pour limiter l'accès.

   

7. Cliquez sur Ajouter.

8. Revenez sur la page précédente (Configuration → Générale → API) et cliquez sur le client API (esia) dans la liste.

   

9. La clé API générée s’affiche : copiez-la et stockez-la en lieu sûr.

   

Nous vous conseillons de configurer un nouveau profil utilisateur pour Esia avec uniquement les accès requis. Si cela n'est pas un problème pour vous, vous pouvez passer cette étape et utiliser le profil « Admin » pour l'utilisateur Esia.

1. Dans le menu principal, cliquez sur Administration → Profils.

2. Cliquez sur Ajouter.

   

3. Donnez-lui un nom et cliquez sur Ajouter.

   

4. Revenez sur la page précédente (Administration → Profils) et cliquez sur le nouveau profil (esia) dans la liste.

   

5. Allez dans le menu Parc et sélectionnez tout en Lecture. Cela permettra à Esia de lier le Nœud qui génère le ticket avec le parc GLPI s'il trouve un device du même nom.

   Puis cliquez sur Sauvegarder.

   

6. Allez dans le menu Assistance et configurez les sections suivantes comme sur les images.

   Section Tickets :

   

   Section Suivis / Tâches :

   

   Section Validations :

   

   Section Association :

   

   Puis cliquez sur Sauvegarder en bas de la page.

7. Allez dans le menu Administration et dans la section Administration, sélectionnez Utilisateurs en Lecture.

   Cela est nécessaire pour retrouver l'ID de l'utilisateur (esia) qui crée les tickets.

   

   Puis cliquez sur Sauvegarder en bas de la page.

   La configuration du profil est terminée !

1. Dans le menu principal, cliquez sur Administration → Utilisateurs.

2. Cliquez sur l'action : Ajouter utilisateur.

   

3. Remplissez les données de l'utilisateur en veillant à bien sélectionner « Oui » pour Actif

   Ajoutez-lui le profil Esia créé à l'étape Configurer un profil utilisateur.

   

4. Cliquez sur Ajouter pour créer l’utilisateur.

5. Revenez sur la page précédente (Administration → Utilisateurs) et cliquez sur le nouvel utilisateur (esia) dans la liste.

   

6. En bas de la page, dans Clefs d'accès distant → Jeton d'API, cocher la case Regénérer, puis cliquez sur Sauvegarder.

   

7. La clé utilisateur générée s’affiche : copiez-la et stockez-la en lieu sûr.

   

   Attention, ce token doit être regénéré à chaque modification des droits d'accès (profil) utilisateur.

En ligne de commande sur le serveur, éditer le fichier /etc/esia/glpi.conf (Une fois que vous aurez terminé avec nano, taper ctrl+x puis y pour sauvegarder le fichier)

copy

nano /etc/esia/glpi.conf

Son contenu doit ressembler à ceci :

/etc/esia/glpi.conf

host="https://monserveurglpi.com/glpi"
app_token="vrFkHRcPTYt4Dt79zD78oPuiGKRYlAJGqsYr9kjv"
user_token="YjJC9qCUHSK8JKY1BSsJ2wDfg8IgBid1c1okKsrM"
user_name="esia"
tpl_title="( %node.group.name ) %node.name:%service.name"

Le fichier contient les paires clés=valeurs suivantes :

• host=“URL d'accès à votre serveur GLPI”

• app_token=“Jeton d'application que vous avez copié dans l'interface GLPI”

• user_token=“Jeton d'API utilisateur que vous avez copié dans l'interface GLPI”

• user_name=“Nom de l'utilisateur qui sera utilisé en tant que Demandeur des tickets générés par Esia”

• tpl_title=“Template du titre des tickets”

  Ce template permet de formater les titres des tickets qui seront créés. Les mots-clés qui commencent par % comme %node.name seront remplacés par des variables. C'est le même principe qu'avec le template de mail.

  Nous vous conseillons d'utiliser celui de l'exemple ci-dessus où les mots-clés sont :

  • %node.group.name ⇒ groupe du nœud
  • %node.name ⇒ nom du nœud
  • %service.name ⇒ nom du service

La configuration se fait via l'interface web d'Esia. De la même manière que pour configurer des alertes mails. Voir gestion des alertes.

Deux programmes d'alertes permettent d'envoyer des tickets vers GLPI

• Ticket GLPI ⇒ génère uniquement un ticket sur GLPI
• Ticket GLPI & Mail ⇒ génère un ticket sur GLPI et envoie une alerte Esia par mail (comme SEND_MAIL)

Configurer les tickets par service Comme pour les autres programmes d'alerte :

1. Cochez les services pour lesquels vous souhaitez configurer un ticket.

   Vous pouvez configurer les services un par un ou utiliser la section « Actions Groupées » pour paramétrer tous les services sélectionnés en même temps.

2. Choisissez le programme d'alerte :

   • Ticket GLPI (SEND_TICKET_GLPI)

   • Ticket GLPI & Mail (SEND_TICKET_GLPI_MAIL)

     L'adresse mail de votre utilisateur s'ajoute automatiquement, mais vous pouvez la modifier.

3. Paramétrez le programme d'alerte.

   Dans la ligne de commande le -L correspond à la priorité du ticket. Plus le chiffre est grand, plus la priorité est élevée. Voici la liste des priorités correspondantes :

   • -L 1 ⇒ Très basse

   • -L 2 ⇒ Basse

   • -L 3 ⇒ Moyenne

   • -L 4 ⇒ Haute

   • -L 5 ⇒ Très haute

   • -L 6 ⇒ Majeure

4. Ensuite, cochez le type d'alerte pour lequel vous désirez être averti.

   • Alerte, Critique, Inconnu ⇒ À la première erreur sur le service, un nouveau ticket est créé dans GLPI. Les changements de statut suivants modifient la priorité (en fonction du type d'erreur) et affiche un message de changement de statut sur le ticket. ⇐ TODO (priorité change ou pas finalement ?)

   • OK ⇒ Considère que l'erreur a été corrigée et que le ticket est terminé. Affiche un message sur le ticket et lorsqu'une prochaine erreur surviendra, un nouveau ticket sera créé.

     Attention : Si le status « OK » n'est pas coché, il n'y aura que des changements de statut de service sur le ticket et jamais de nouveau ticket pour ce service.

   • Acquittement ⇒ À venir (Esia 3.6.0) Préviens dans les messages du ticket que l'erreur a été acquittée ou dés-acquittée.

5. N'oubliez pas de cliquer sur « Mettre à jour ».

Lorsqu'un nouveau ticket est créé, une note de noeud s'affiche avec le lien vers le ticket

Une autre note s'affiche lorsqu'un ticket est terminé (Il faut que le statut OK soit coché dans la configuration du programme d'alerte)

• 1 ⇒ Très basse

• 2 ⇒ Basse

• 3 ⇒ Moyenne

• 4 ⇒ Haute

• 5 ⇒ Très haute

• 6 ⇒ Majeure