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
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 passez 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 argument3Un 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, à l’aide du 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.bashUn exemple Python avec des commentaires en ligne peut 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 de 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.| 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 | Fonctionnalités MID | Chaîne (séparée par des virgules) | Liste des options de MID Server requises. |
| Options de valeur | valueCapabilities (en anglais seulement) | Tableau de la carte de hachage | Valeurs d’aptitude utilisées pour sélectionner le MID Server. Pour plus d’informations, consultez Options du MID Server. Si des options supplémentaires sont affectées par valeur, utilisez cet exemple pour personnaliser la sélection du MID Server : |
| Exécution longue | long_running | Booléen | Indique si la commande est longue ou non. La valeur true indique que la commande s’exécute longtemps. |
| 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 Sudo SSH doivent être utilisées.SSH credentials |
Analyse des paramètres de post-traitement et de la charge utile SSH
Utilisez ces paramètres pour créer un script de post-traitement, une analyse de la charge utile et un balisage.
| Nom | Variable | Type | Utilisation |
|---|---|---|---|
| Sortie | output | Chaîne | Contient la sortie renvoyée par la commande SSH. |
| EccSysID (en anglais) | eccSysID | Chaîne | Contient l’ID de référence associé au message d’entrée de 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 :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 nom de la balise. |
Configurer la commande d’exécution SSH
Utilisez les variables d’entrée que vous avez créées pour configurer la commande exécutée par Orchestration sur la cible hôte.
Avant de commencer
Rôle requis : activity_creator, admin
Remarque :
Vous pouvez tester la connexion SSH entre le MID Server et la cible sans avoir à exécuter l’activité dans un contexte de workflow. Pour plus d’informations, consultez Sorties du modèle de test.