Partager via

Assistant Activité de ligne de commande

  • Article

L’Assistant Activité de ligne de commande vous permet de créer rapidement de nouvelles activités dans Orchestrator en encapsulant des commandes, des arguments et des paramètres dans un assembly Microsoft .NET (.DLL). L’Assistant crée automatiquement du code source C# à l’aide du Kit de développement logiciel (SDK) Orchestrator et le compile pour vous. À l’aide de cet assembly, vous pouvez utiliser le pack d’intégration .NET (partie du Kit de ressources d’intégration) pour tester vos activités, puis utiliser l’Assistant Integration Pack pour empaqueter l’assembly dans un pack d’intégration personnalisé qui peut être distribué et déployé comme d’autres packs d’intégration.

Un assembly peut contenir une ou plusieurs activités (commandes) et les activités peuvent être un ou plusieurs des types de commandes disponibles (commande, ligne de commande, PowerShell ou commande SSH). Vous définissez le nom de l’activité, la structure de commandes, les paramètres d’entrée et même les données publiées (sortie).

Vue d’ensemble des activités dans Orchestrator

Une activité est une partie fonctionnelle unique d’un runbook Orchestrator. Les activités sont ce que font le travail réel dans les runbooks et sont jointes à l’aide de liens qui peuvent être définis avec des conditions pour créer des branches de flux de travail. Lors de la création d’un runbook à l’aide du Runbook Designer, vous faites glisser et déposez des activités du volet Activités dans le runbook et liez-les ensemble pour former le flux de travail. Au fur et à mesure que le runbook s’exécute, il appelle chaque activité en séquence en fonction de la façon dont elles ont été liées. Chaque activité effectue un devoir spécifique et peut collecter des données d’entrée à partir du bus de données Orchestrator et publier sa sortie dans le même bus de données. Chaque activité a la possibilité de dessiner des données publiées à partir de l’une des activités qui s’y sont exécutées avant le runbook, et la publication des données de sortie permet aux activités suivantes d’y accéder.

Les activités vont de simples à complexes. Vous pouvez créer une activité à l’aide de l’Assistant Activité de ligne de commande qui ne fait rien, mais qui renvoie du texte à une propriété de sortie. Vous pouvez également créer une activité unique qui effectue une action complexe en plusieurs étapes, comme le déploiement de machines virtuelles. C’est à vous de définir ce que fera chaque activité. Toutefois, votre objectif doit être de définir des activités qui encapsulent des ensembles uniques de fonctionnalités qui permettent une réutilisation facile dans de nombreux types de situations différents. La clé est la flexibilité. Il est préférable de créer un ensemble de 10 activités différentes qui font chacun quelque chose de spécifique et de pouvoir utiliser ces activités de 20 façons différentes, plutôt que de créer 20 activités différentes pour résoudre les scénarios individuels spécifiques. Plus d’informations sur les meilleures pratiques sont abordées plus loin dans ce document.

Créer un assembly d’activité

Procédez comme suit pour créer un assembly d’activité de ligne de commande :

  1. Sélectionner Démarrer > tous les programmes > Microsoft System Center 2012 > Orchestrator > Integration Toolkit > Orchestrator , Assistant Activité en ligne de commande

  2. Cliquez sur Suivant.

  3. Dans la page Détails de l’assembly, entrez une valeur pour Name qui commence par une lettre et est suivie de zéro ou plusieurs caractères alphanumériques. Ce nom est utilisé comme identificateur d’espace de noms C# pour l’assembly et vos activités.

  4. Dans le fichier Assembly, entrez un chemin d’accès et un nom de fichier du fichier d’assembly qui sera créé par cet Assistant. Si ce fichier existe déjà, vous êtes invité à remplacer le fichier.

  5. Sélectionnez les informations d’assembly. Vous pouvez entrer des informations ici qui deviendront les propriétés du fichier d’assembly, visibles dans l’Explorateur Windows via des propriétés de fichier. Les valeurs de propriété sont définies dans le tableau ci-dessous. Ces informations sont facultatives et non requises pour générer un assembly.

    Propriété Description
    Titre Spécifie un titre pour l’assembly, qui apparaît comme propriété de description de fichier dans les propriétés de l’Explorateur Windows
    Description Spécifie une description facultative de l’assembly, qui n’apparaît pas dans les propriétés de l’Explorateur Windows
    Produit Spécifie un nom de produit pour l’assembly, qui apparaît comme propriété Product name dans les propriétés de l’Explorateur Windows
    Company Spécifie un nom d’entreprise pour l’assembly, qui n’apparaît pas dans les propriétés de l’Explorateur Windows
    Copyright Spécifie un avis de copyright pour l’assembly, qui apparaît comme copyright dans les propriétés de l’Explorateur Windows
    Marque Spécifie une marque pour l’assembly, qui apparaît en tant que marques légales dans les propriétés de l’Explorateur Windows
    Version Spécifie la version de l’assembly et la version du fichier. Celles-ci apparaissent dans les propriétés de l’Explorateur Windows en tant que version de fichier et version de produit.

    Le numéro de version comporte quatre parties comme suit :

    <version majeure>.<version mineure>.<numéro de build>.<révision>

  6. Sélectionnez OK lorsque vous avez terminé d’entrer des informations d’assembly.

  7. Cliquez sur Suivant. La page Commandes s’affiche.

  8. Ajoutez une ou plusieurs commandes en suivant les instructions fournies dans Ajouter des commandes à un assembly.

  9. Lorsque vous avez terminé la définition de votre activité, sélectionnez OK. La boîte de dialogue se ferme et votre nouvelle activité est ajoutée à la liste dans la page Commandes . Si vous devez revenir en arrière et modifier une commande, sélectionnez la commande dans la liste, puis sélectionnez Modifier. Si vous devez supprimer une commande, sélectionnez la commande dans la liste, puis sélectionnez Supprimer.

  10. Lorsque vous avez terminé d’ajouter et de modifier des commandes, sélectionnez Suivant. Le fichier d’assembly spécifié au début de l’Assistant est compilé et lorsque le processus est terminé, la page finale de l’Assistant s’affiche.

  11. Si vous souhaitez générer immédiatement un pack d’intégration à partir de ce nouvel assembly, sélectionnez le bouton Build Integration Pack , qui lance l’Assistant Integration Pack et précharge les informations de l’assembly. Suivez ensuite les instructions de création d’un pack d’intégration pour créer le pack d’intégration.

  12. Si vous souhaitez tester votre assembly à l’aide de l’activité Invoke .NET ou ignorer simplement le processus de génération IP pour l’instant, sélectionnez Terminer.

Ajouter des commandes à un assembly

Procédez comme suit pour ajouter une commande à un assembly :

  1. Dans la page Commandes , vous pouvez définir une ou plusieurs commandes (qui deviennent des activités) qui seront ajoutées à l’assembly. Pour ajouter une nouvelle commande, sélectionnez Ajouter.

  2. La boîte de dialogue Ajouter/modifier la commande s’affiche et contient trois onglets : Général, Arguments et Données publiées. Entrez un nom pour la commande. Cela devient le nom affiché dans le Runbook Designer pour l’activité. Vous pouvez également entrer une description pour la commande.

  3. Le sélecteur de propriétés mode contient quatre options : Exécuter la commande, Exécuter Windows PowerShell, Exécuter le programme et exécuter la commande SSH. Si vous avez sélectionné le mode Exécuter le programme , le champ Programme devient actif. Sélectionnez le bouton de sélection (...) et recherchez le programme que vous souhaitez exécuter.

    Remarque

    Le programme sélectionné dans une commande Run Program est appelé sur le Runbook Server où le runbook contenant cette activité est exécuté. Par conséquent, ce programme doit exister sur tous les serveurs Runbook où vous prévoyez d’exécuter le runbook.

  4. Sélectionnez l’onglet Arguments .

  5. Dans le champ Ligne de commande, tapez les paramètres de ligne de commande ou de ligne de commande nécessaires à votre activité. Si votre commande prend les paramètres que vous souhaitez que les utilisateurs spécifient, vous devez les ajouter dans la liste Paramètres ci-dessous, puis utiliser le bouton Insérer pour les ajouter à la ligne de commande.

    Important

    Si vous avez spécifié Exécuter Windows PowerShell pour le mode et que vous référencez un script PowerShell inclus dans votre pack d’intégration, vous devez précéder le nom du script avec des points et des barres obliques pour faire référence au répertoire local. Par exemple, .\MyScript.ps1 serait spécifié pour un script nommé MyScript.ps1. Cela est dû au fait que le fichier de script est copié dans le répertoire par défaut du pack d’intégration. Lorsque Windows PowerShell exécute un script à partir du répertoire local, il doit spécifier cette notation.

  6. Pour fournir des paramètres pour une ligne de commande, sélectionnez Ajouter. La boîte de dialogue Ajouter/modifier un paramètre s’affiche.

  7. Dans le champ Nom, tapez un nom pour le paramètre que vous ajoutez. Il s’agit du nom complet du paramètre affiché dans la liste Propriétés de l’activité.

  8. Dans la liste déroulante Mode d’utilisation, sélectionnez le mode que vous utiliserez pour le paramètre. Le mode Utilisation a deux choix :

    Mode d’utilisation Description
    Argument de commande Sélectionnez cette option comme paramètre dans votre ligne de commande (à l’aide du bouton Insérer ). Par exemple, un paramètre d’argument de commande nommé « Folder » peut être placé dans la ligne de commande comme suit :

    Dir $(folder)Note: Si les arguments de ligne de commande contiennent des espaces (tels que des noms de dossiers), vous devrez peut-être les placer entre guillemets pour que la commande fonctionne correctement. Par exemple : Dir "$(folder)"
    Variable d’environnement Sélectionnez cette option pour utiliser cet argument comme variable d’environnement qui sera définie avant l’exécution de la ligne de commande. Il peut être utilisé comme paramètre de ligne de commande ou comme variable d’environnement au sein d’un script qui est exécuté.

    Par exemple, un paramètre de variable d’environnement nommé « Folder » peut être placé dans la ligne de commande comme suit :

    Dir %Folder%Important: Le nom de la variable d’environnement existe déjà dans les environnements utilisateur ou système ; la commande échoue avec un message d’erreur similaire à ce qui suit : l’élément a déjà été ajouté. Clé dans le dictionnaire : clé « dossier » ajoutée : « dossier ». Vous pouvez déterminer quelles variables d’environnement existent sur un ordinateur local ou distant en sélectionnant Démarrer > l’exécution et en tapant MSINFO32.EXE. Sélectionnez Ensuite les variables d’environnement de l’environnement > logiciel. Pour sélectionner un autre ordinateur, appuyez sur <Ctrl+R>, sélectionnez Ordinateur distant sur le réseau, entrez le nom de l’ordinateur, puis sélectionnez OK.

  9. Dans la liste déroulante Afficher le style , sélectionnez le style que vous utiliserez pour afficher le paramètre. Le style d’affichage détermine la façon dont l’utilisateur interagit avec l’entrée lorsqu’il est présenté à lui. Les choix sont décrits ci-dessous :

    Style d’affichage Description
    Texte L’utilisateur sera présenté avec une zone de texte de forme libre pour entrer une valeur
    Texte chiffré L’utilisateur sera présenté avec une zone de texte masquée. Les données de ce champ seront chiffrées dans la base de données et ne seront affichées dans aucun journal
    Vrai/Faux L’utilisateur peut sélectionner True ou False dans une boîte de dialogue contextuelle
    Texte avec sélection L’utilisateur peut sélectionner dans un groupe d’options que vous spécifiez
    Date/heure L’utilisateur peut sélectionner la valeur à l’aide d’un contrôle Sélecteur de date/heure
    File L’utilisateur peut sélectionner la valeur à l’aide d’un contrôle Explorateur de fichiers
    Dossier L’utilisateur peut sélectionner la valeur à l’aide d’un contrôle Folder Browser
    Computer L’utilisateur peut sélectionner la valeur à l’aide d’un contrôle Computer Browser

  10. Si le paramètre nécessite ou si vous souhaitez fournir une valeur par défaut, tapez-le dans le champ Valeur par défaut.

  11. Si vous avez sélectionné Texte avec sélection, le champ Options est activé. Pour ajouter des valeurs d’option que l’utilisateur peut sélectionner, sélectionnez le bouton de sélection en regard du champ Options et entrez-les. Chaque option est répertoriée sur une ligne distincte. Lorsque vous avez terminé d’ajouter des options, sélectionnez OK.

  12. Une fois la définition de paramètre terminée, sélectionnez OK.

  13. S’il est défini comme paramètre de commande, le paramètre peut maintenant être ajouté à la ligne de commande en plaçant le curseur au point d’insertion souhaité dans la ligne de commande, puis en sélectionnant le bouton Insérer et en sélectionnant le nom du paramètre. Si elle est définie en tant que variable d’environnement, vous devez taper manuellement la variable (au format %variable%) si vous le souhaitez dans la ligne de commande.

  14. Si vous avez choisi les modes Exécuter le programme ou exécuter la ligne de commande, la case à cocher pour inclure le paramètre de répertoire de travail est activée.

  15. Sélectionnez l’onglet Données publiées. Les paramètres de cet onglet vous permettent de publier des données de sortie dans le bus de données Orchestrator afin que d’autres activités puissent utiliser les informations.

  16. Pour ajouter une nouvelle propriété de données publiée, sélectionnez Ajouter.

  17. Si vous avez sélectionné l’option Exécuter la commande, exécuter le programme ou exécuter une commande SSH dans la liste déroulante Mode sous l’onglet Général de la boîte de dialogue Ajouter/modifier la commande , les éléments suivants s’affichent dans la boîte de dialogue Ajouter/Modifier des données publiées :

    Articles Description
    Nom Nom complet de l’élément de données publiées que vous créez
    Source Source de l’élément de données publiées. Vous pouvez choisir parmi le flux de sortie standard ou le flux d’erreur standard à partir de la ligne de commande
    Mode Mode que vous souhaitez utiliser pour sélectionner les données publiées.

    Utilisez le modèle de correspondance pour déterminer si un modèle donné est trouvé dans la source. Cette opération renvoie True ou False.

    Utiliser le groupe d’extraction pour récupérer chaque élément de données qui correspond au modèle que vous spécifiez
    Modèle Expression régulière qui s’applique au paramètre Mode
    Description Texte de description qui s’affiche en regard de la propriété de données publiée dans Runbook Designer. (facultatif)

  18. Si vous avez sélectionné l’option Exécuter Windows PowerShell dans la liste déroulante Mode sous l’onglet Général de la boîte de dialogue Ajouter/Modifier une commande, les éléments suivants s’affichent dans la boîte de dialogue Ajouter/Modifier des données publiées :

    Articles Description
    Nom Nom complet de l’élément de données publiées que vous créez
    Propriété Nom de la propriété Windows PowerShell qui sera enregistrée dans l’élément De données publiées. Cette propriété doit être contenue dans une sortie d’objet vers le pipeline PowerShell pendant le script et ne doit pas être un objet (doit être en mesure d’être converti en chaîne).
    Description Texte de description qui s’affiche en regard de la propriété de données publiée dans Runbook Designer. (facultatif)

  19. Sélectionnez OK pour terminer l’ajout de l’élément De données publiées. Répétez les étapes 16-18 pour chaque élément de données publié que vous souhaitez ajouter.

  20. Sélectionnez OK pour fermer la boîte de dialogue Ajouter/modifier la commande et revenir à la boîte de dialogue Commandes.

Tester un assembly d’activité

Une fois que vous avez créé un assembly, vous pouvez le tester à l’aide de l’activité Invoke .NET (contenue dans l’adresse IP integration Toolkit pour .NET) pour vérifier qu’il fonctionne comme prévu avant de le convertir en pack d’intégration personnalisé.

Tester un assembly

Procédez comme suit pour tester un assembly :

  1. Ouvrez Runbook Designer.

  2. Créez un nouveau Runbook.

  3. Dans le volet Activités , sélectionnez la catégorie Integration Toolkit pour la développer, puis faites glisser une activité Invoke .NET dans le nouveau runbook.

  4. Double-cliquez sur l’objet Invoke .NET pour afficher la boîte de dialogue Propriétés .

  5. Dans le champ Assembly , recherchez le fichier d’assembly que vous avez créé à l’aide de l’Assistant Activité de ligne de commande (ou via le développement personnalisé à l’aide du SDK) en sélectionnant le bouton de sélection (...) à droite du champ. Sélectionnez le fichier, puis sélectionnez Ouvrir.

  6. Sélectionnez le bouton de sélection à droite du champ Classe pour afficher une liste des commandes individuelles dans l’assembly. Sélectionnez une classe de commandes, puis sélectionnez OK. Les paramètres de cette classe s’affichent sous l’onglet Propriétés de la boîte de dialogue.

  7. Le champ d’installation est utilisé uniquement par des classes développées personnalisées à l’aide du Kit de développement logiciel (SDK) Orchestrator avec l’attribut OrchestratorData. Pour plus d’informations sur le Kit de développement logiciel (SDK), consultez le Kit de développement logiciel (SDK) System Center Orchestrator Integration Toolkit.

  8. Sélectionnez l’onglet Propriétés.

  9. Fournissez les informations pour chacune des propriétés si nécessaire.

  10. Sélectionnez Terminer pour enregistrer les paramètres et revenir au runbook.

  11. Sélectionnez Runbook Tester dans la barre d’outils du Runbook Designer. Le Runbook Tester démarre.

  12. Sélectionnez Exécuter jusqu’au point d’arrêt dans la barre d’outils. Le runbook démarre et votre activité s’exécute. Les résultats de l’activité sont affichés dans le volet Exécuter le journal .

  13. Sélectionnez Afficher les détails sous le nom de l’activité dans le volet Journal d’exécution pour afficher les résultats détaillés, y compris les propriétés d’entrée et les données publiées.

Migration de l’activité CLI QIK

Si vous avez un assembly créé à l’aide de l’Assistant CLI QIK Opalis 6.3, vous devez le convertir pour qu’il soit compatible avec Orchestrator avant de pouvoir être utilisé dans un Pack d’intégration Orchestrator ou directement dans les runbooks via l’activité Invoke .NET. Le processus de conversion est simple et ne prend que quelques secondes par assembly.

Important

L’installation de Orchestrator Integration Toolkit ne échouera pas si Microsoft .NET Framework 3.5, Service Pack 1 n’est pas installé, mais différentes opérations de l’Assistant Activité de ligne de commande échouent si elle n’est pas présente. Vérifiez que Microsoft .NET Framework 3.5, Service Pack 1 est installé avant d’utiliser l’interface CLI.

Convertir un assembly CLI QIK Opalis

Procédez comme suit pour convertir un assembly CLI QIK Opalis :

  1. Lancez l’Assistant Activité en ligne de commande Orchestrator en sélectionnant Démarrer > tous les programmes > Microsoft System Center 2012 > Orchestrator > , Activité en ligne de commande

  2. Lorsque l’Assistant se charge, sélectionnez le bouton Charger l’assembly existant sur la première page.

  3. Sélectionnez votre fichier d’assembly existant, puis sélectionnez Ouvrir. Le nom et l’emplacement du fichier de l’assembly sont affichés.

  4. Modifiez le chemin d’accès du fichier afin que les modifications soient enregistrées dans un nouveau fichier. Vous pouvez également modifier le nom de l’assembly si nécessaire.

  5. Si vous devez apporter d’autres modifications aux détails des informations d’assembly, sélectionnez le bouton Informations sur l’assembly et apportez ces modifications. Sélectionnez OK lorsque vous avez terminé pour revenir à la page Détails de l’assembly.

  6. Sélectionnez Suivant pour accéder à la page Commandes. Vous devez voir une liste de commandes qui ont été précédemment définies dans l’assembly. Si nécessaire, passez en revue les commandes, puis sélectionnez Suivant pour passer à la page Assembly de génération.

  7. Votre nouvel assembly sera généré pour vous et enregistré à l’aide du chemin d’accès et du nom de fichier que vous avez définis précédemment.

  8. Vous pouvez maintenant utiliser votre nouvel assembly compatible Orchestrator dans les runbooks avec l’activité Invoke .NET, ou vous pouvez créer un pack d’intégration à partir de cet assembly en sélectionnant le bouton Générer le pack d’intégration. Si vous ne souhaitez pas générer une adresse IP pour l’instant, sélectionnez Fermer pour terminer l’Assistant.

Ressources Orchestrator

Outre cette référence en ligne fournie pour System Center 2012 Orchestrator, il existe un certain nombre de ressources qui peuvent fournir des informations supplémentaires sur la création de runbooks, l’utilisation du Kit de ressources d’intégration et les meilleures pratiques.