Créer une activité SSH

Créez une activité qui extrait les données d’un hôte cible qui utilise le protocole réseau SSH.

Avant de commencer

Rôle requis : activity_creator ou workflow_admin

Pourquoi et quand exécuter cette tâche

Pour obtenir des instructions sur l’utilisation du flux de processus du modèle d’activité, consultez Créer des activités personnalisées.

Procédure

1. Créez une activité personnalisée.
   Cette action crée une activité personnalisée à l’aide d’un modèle.
2. Après avoir configuré les propriétés générales et créé des variables d’entrée, configurez la commande d’exécution SSH.

   Option	Description
   Mapper les variables d’entrée	Utilisez les variables que vous avez créées pour configurer la commande exécutée par Orchestration.
   Hôte cible	Nom d’hôte ou adresse IP du serveur cible pour cette activité.
   Commande	Commande que cette activité exécute sur l’hôte cible. Vous pouvez invoquer un script de Serveur MID à partir de ce champ en utilisant n’importe quel type de script pris en charge par la ligne de commande SSH. Pour plus d’informations, reportez-vous à la section Options de script SSH avancées sous le tableau.
   Répertoire	Répertoire sur l'hôte cible sur lequel la commande est exécutée.
   Balise d’informations d’identification	La balise d’informations d’identification Orchestration à utiliser lors de l’exécution de la commande.
   Options de Serveur MID requises	Serveur MID avec les options appropriées pour se connecter à l’hôte. Par défaut, le système sélectionne un Serveur MID avec des options SSH.
   Exécution longue	Si cette option est activée, le délai de connexion SSH est désactivé pour les commandes dont l’exécution peut prendre plus de temps que les 60 secondes par défaut. Orchestration vérifie périodiquement le processus en cours pour déterminer son état jusqu’à ce qu’il soit terminé.
   Doit Sudo	Si cette option est activée, l’utilisation de sudo pour exécuter des commandes.

   Remarque :

   Vous pouvez mapper automatiquement les valeurs des paramètres d’une charge utile de test aux variables de l’onglet Sorties . Reportez-vous à la section Variables de sortie de mappage automatique.

Options de script SSH avancées

Pour exécuter un Serveur MID script sur l’hôte cible, spécifiez le type de script et transmettez le nom du script dans le paramètre ${syncFile()} . Le système utilise ce paramètre pour localiser le script nommé dans la table Fichier de script du serveur MID [ecc_agent_script_file] et l’exécuter sur l’hôte cible. Par exemple, un script bash peut être exprimé comme suit :

bash ${syncFile("<MID script name>")} argument1 argument2 argument3

Un script de base (main_script.bash) peut référencer un autre script (my_include.bash) ainsi qu’un fichier distinct (.my_profile) situé sur l’hôte cible. Les deux scripts et le fichier référencé doivent être synchronisés avec le Serveur MID, en utilisant le paramètre ${syncFile()} , pour s’exécuter correctement.

source ${syncFile(".my_profile")}
cp ${syncFile("my_include.bash")} /usr/ssmith/my_include.bash
bash ${syncFile("main_script.bash")} one two three four five six 
rm /usr/ssmith/my_include.bash

Un exemple Python avec des commentaires en ligne pourrait ressembler à ceci :

set $LIB_DIR=/usr/bin;. 
# Sync a file that is referenced inside myF5CreateLBPool.py 
cp ${syncFile("specialFunctions.py")} ~/specialFunctions.py 
# set up environment variables 
source ${syncFile(".python_profile")} 
# call script that sets up dependencies on the box from remote package repos 
python ${syncFile("setupPythonDependencies.py")} pycontrol 
# call a script that requires functions from the package as well as a function from myIncludedFile 
python ${syncFile("myF5CreateLBPool.py")} snow_pool myActualValue 
# user is responsible for their own cleanup 
rm ~/specialFunctions.py 

Que faire ensuite

• Utiliser le mappage automatique pour générer des sorties et des règles d’analyse
• Si vous n’utilisez pas le mappage automatique, vous pouvez créer manuellement des variables de sortie et créer des règles d’analyse

Paramètres d’exécution du modèle SSH

Utilisez les paramètres d’exécution pour créer le script de processus d’entrée dans le formulaire Prétraitement du concepteur d’activité.

Pour obtenir une description des champs de commande, reportez-vous à la section Configurer la commande d’exécution SSH.

Remarque :

Vous devez utiliser le préfixe executionParam. avec toutes les variables de cette table.

Tableau 1. Paramètres d’exécution SSH

Nom	Variable	Type	Utilisation
Source	source	Chaîne	Cible ou hôte prévu.
Commande	commande	Chaîne	Commentaire à exécuter sur l’hôte.
Répertoire	répertoire	Chaîne	Répertoire sur l’hôte dans lequel exécuter la commande.
Balise d’informations d’identification	credential_tag	Chaîne	Balise d’informations d’identification Orchestration à utiliser lors de l’exécution de la commande.
Capacités MID	Capacités MID	Chaîne (séparée par des virgules)	Liste des options de Serveur MID requises.
Options de valeur	valueCapabilities (en anglais seulement)	Tableau de la carte de hachage	Valeurs d’aptitude utilisées pour sélectionner le serveur MID. Pour plus d’informations, consultez Options de Serveur MID. Si des options supplémentaires sont affectées par valeur, utilisez cet exemple pour personnaliser la sélection du Serveur MID : var valueCapability = {'NEW_MID_CAPABIILTY':'NEW_MID_CAPABILITY_VALUE'}; executionParam.valueCapabilities.push(valueCapability);
Exécution longue	long_running	Booléen	Indique si la commande est longue ou non. La valeur vrai indique que la commande a une exécution longue.
Doit sudo	must_sudo	Booléen	Indique si cette activité doit utiliser Sudo pour exécuter les commandes racine. La valeur vrai indique que les informations d’identification SSHSudo doivent être utilisées.

Paramètres de post-traitement SSH et analyse de la charge utile

Utilisez ces paramètres pour créer un script de post-traitement, une analyse de la charge utile et un balisage.

Tableau 2. Paramètres de post-traitement SSH

Nom	Variable	Type	Utilisation
Sortie	sortie	Chaîne	Contient la sortie renvoyée par la commande SSH.
EccSysID (en anglais seulement)	eccSysID	Chaîne	Contient l’ID de référence associé au message d’entrée File d’attente ECC renvoyé par l’activité.
Messages d’erreur	Messages d’erreur	Chaîne	Contient les messages d’erreur récupérés à partir de la commande SSH. Cette valeur est nulle s’il n’y a pas de messages d’erreur.
Balises	balises	Carte de hachage des valeurs de balises renvoyées par la commande SSH	Contient les balises utilisées pour extraire la sortie à l’aide des commandes SSH. La sortie de la balise est délimitée par des signes de pourcentage doubles, comme dans %%tagname%% ... %%. Configurez la commande à l’aide du format suivant : %%tagname1%% output1 line 1 output1 line 2 … %% %%tagname2%% output2 line 1 output2 line 2 … %% Les balises renvoyées sont des objets de carte de hachage JavaScript dans lesquels chaque clé est préfixée par une balise accompagnée du tagname. {"__text__": "", "tagtagname1":"output1 line1\noutput1 line2\n", "tagtagname2":"output2 line1\noutput2 line2\n"}

Configurer la commande d’exécution SSH

Utilisez les variables d’entrée que vous avez créées pour configurer la commande qu’Orchestration exécute sur la cible hôte.

Avant de commencer

Créez les variables d’entrée dont vous avez besoin dans le formulaire Entrées avant de passer à l’étape Commande d’exécution .

Rôle requis : activity_creator, admin

Remarque :

Vous pouvez tester la connexion SSH entre le serveur MID et la cible sans avoir à exécuter l’activité dans un contexte de workflow. Pour plus d’informations, consultez les sorties des modèles de test.

Procédure

1. Faites glisser les variables de la liste des entrées et déposez-les dans les champs de commande.
   Le système formate la variable dans la syntaxe appropriée pour la commande.

   Figure 1. Commande d’exécution SSH

   

2. Renseignez les champs affichés dans la table.

   Tableau 3. Entrées d’activité SSH

   Champ	Description
   Entrée	Générateur de variables d’entrée. Créer des variables d’entrée pour mapper aux champs disponibles.
   Hôte cible	Nom d’hôte ou adresse IP du serveur cible pour cette activité.
   Commande	Commande que cette activité exécute sur l’hôte cible. Vous pouvez invoquer un script de Serveur MID à partir de ce champ à l’aide de n’importe quel type de script pris en charge par la ligne de commande SSH. Pour plus d’informations, reportez-vous à la section Options de script SSH avancées sous le tableau.
   Répertoire	Répertoire sur l'hôte cible sur lequel la commande est exécutée.
   Balise d’informations d’identification	Alias d’informations d’identification pour les activités Orchestration à utiliser pendant l’exécution de la commande.
   Sélectionner Serveur MID par capacités	Serveur MID avec les options appropriées pour se connecter à l’hôte. Par défaut, le système sélectionne un Serveur MID avec des options SSH
   Exécution longue	Case à cocher pour désactiver le délai de connexion SSH pour les commandes dont l’exécution peut prendre plus de temps que les 60 secondes par défaut. Orchestration vérifie périodiquement le processus en cours pour déterminer son état jusqu’à ce qu’il soit terminé.
   Doit Sudo	Case à cocher autorisant l’utilisation des informations d’identification SSH pour exécuter des commandes.

3. Cliquez sur Enregistrer.
4. Cliquez sur Continuer pour passer à l’étape Sorties .