Aller au contenu principal

Recherche de Texte sur Unix

Configuration actuelle de la tâche Unix Search Text dans le Workflow Designer
  • Type de tâche: ssh_searchtext

Description​

La tâche Recherche de Texte sur Unix permet de rechercher une chaîne ou un motif de texte dans un fichier, soit sur un serveur distant (via SSH) soit sur la machine locale (mode Par défaut).

Elle peut être utilisée pour analyser des fichiers de logs, identifier des messages d'erreur ou vérifier la présence de certaines informations dans des fichiers de configuration ou de texte.

Configuration​

La configuration de la tâche définit les détails de la connexion (le cas échéant), le fichier à analyser et le texte à rechercher. Les champs de configuration de la tâche peuvent être valorisés manuellement ou via paramètres et variables du flux de travail.

Connexion au Serveur​

  • Mode de connexion: définit la source des identifiants utilisés pour la connexion. Il peut prendre trois modes d'opération :
  • Par défaut: la recherche est effectuée sur la machine locale, sans connexion SSH.
  • Manuel: permet d'entrer manuellement les paramètres de connexion SSH.
  • Environnement: utilise un environnement de connexion préconfiguré. Dans ce mode, un menu est affiché listant les connexions disponibles en fonction du rôle associé au Workflow.
  • Adresse IP: adresse IP du serveur distant.
  • Nom d'hôte: nom d'hôte du serveur distant.
  • Utilisateur: nom d'utilisateur utilisé pour établir la connexion SSH.
  • Mot de passe: mot de passe associé à l'utilisateur de connexion.
  • Port: port utilisé pour la connexion SSH (la valeur par défaut est 22).

Exécuter la commande en tant qu'autre utilisateur​

En activant cette case à cocher, il est possible d'exécuter la recherche avec un utilisateur différent de celui utilisé pour la connexion SSH.

  • Utilisateur: nom de l'utilisateur avec lequel la commande sera exécutée.
  • Mot de passe: mot de passe de l'utilisateur utilisé pour l'exécution de la commande.

Détails de la Recherche​

  • Chemin Fichier: le chemin complet du fichier sur le serveur distant dans lequel la recherche du texte sera effectuée.
  • Motif: le texte ou l'expression à rechercher dans le fichier. À côté du champ de texte, un menu permet de spécifier le mode de recherche :
  • Chaîne: la recherche traitera le motif comme une simple chaîne de texte littérale.
  • RegExp: la recherche interprétera le motif comme une expression régulière, permettant des recherches plus complexes et plus flexibles.
  • Limite Lignes: en activant la case à cocher, il est possible de spécifier le nombre maximum de lignes correspondant au motif que la tâche doit retourner. Si non activé, toutes les lignes trouvées seront retournées.

Paramètres de Sortie​

À la fin de la recherche, la tâche expose les éléments suivants paramètres de sortie, fournissant non seulement les lignes trouvées mais aussi des données quantitatives sur la recherche :

  • result: contient un message textuel décrivant le résultat de l'opération.
  • resultJson: représente le résultat de l'exécution de la tâche au format JSON, incluant des informations générales, les configurations et les détails sur l'exécution.
  • occurrences: un compteur numérique indiquant le nombre total de fois où le Motif a été trouvé. Ceci est particulièrement utile car, si une seule ligne contient plusieurs fois le motif, occurrences le comptera toutes, tandis que result le retournera une seule fois.
  • exitStatus: retourne le code de sortie de la commande grep exécutée sur le serveur.
  • 0: indique qu'au moins une correspondance a été trouvée.
  • 1: indique qu'aucune correspondance n'a été trouvée (ce qui, pour grep, n'est pas une erreur d'exécution).
  • Valeurs supérieures à 1: indiquent une erreur de syntaxe ou un problème d'accès au fichier.

Exemple paramètre resultJson​

{
  "run_info": {
    "status": "Completed",
    "run_result": "Success"
  },
  "output_parameters": {
    "exitStatus": "0"
  }
}

Note

  • La tâche exécute une commande de recherche sur le fichier configuré, localement ou via connexion SSH.
  • Si vous utilisez une connexion distante avec authentification par clés SSH, la clé publique doit être enregistrée sur le serveur.
  • Si l'option « Exécuter la commande en tant qu'autre utilisateur » est activée, la commande est exécutée avec un utilisateur différent de celui de la connexion principale.
  • En mode Par défaut, la recherche est effectuée sur la machine locale et aucune connexion SSH n'est requise.