Befehlszeilenaktivitäts-Assistent
Mit dem Befehlszeilenaktivitäts-Assistenten können Sie schnell neue Aktivitäten in Orchestrator erstellen, indem Sie Befehle, Argumente und Parameter in eine Microsoft .NET-Assembly (.DLL) kapseln. Der Assistent erstellt automatisch mit dem Orchestrator SDK C#-Quellcode und kompiliert ihn für Sie. Mithilfe dieser Assembly können Sie das .NET Integration Pack (Teil des Integration Toolkits) verwenden, um Ihre Aktivitäten zu testen. Dann können Sie den Integration Pack-Assistenten verwenden, um die Assembly in ein benutzerdefiniertes Integrationspaket zu packen, das wie andere Integrationspakete verteilt und bereitgestellt werden kann.
Eine Assembly kann eine oder mehrere Aktivitäten (Befehle) enthalten, und die Aktivitäten können ein oder mehrere der verfügbaren Befehlstypen (Befehl, Befehlszeile, PowerShell oder SSH-Befehl) sein. Sie definieren den Aktivitätsnamen, die Befehlsstruktur, Eingabeparameter und sogar veröffentlichte Daten (Ausgabe).
Übersicht über Aktivitäten in Orchestrator
Eine Aktivität ist ein einzelner funktionaler Teil eines Orchestrator-Runbooks. Aktivitäten sind die eigentliche Arbeit in Runbooks und werden mithilfe von Links verknüpft, die mit Bedingungen definiert werden können, um Workflowzweigen zu erstellen. Beim Erstellen eines Runbooks mit dem Runbook-Designer ziehen Sie Aktivitäten aus dem Bereich „Aktivitäten“ in das Runbook und verknüpfen sie mit dem Workflow. Während das Runbook ausgeführt wird, ruft es alle Aktivitäten der Reihe nach entsprechend der Art und Weise auf, wie sie verknüpft wurden. Jede Aktivität führt eine bestimmte Aufgabe aus und kann Eingabedaten aus dem Orchestrator-Datenbus sammeln und die Ausgabe im selben Datenbus veröffentlichen. Jede Aktivität kann veröffentlichte Daten aus einer der zuvor ausgeführten Aktivitäten in das Runbook übernehmen, und durch das Veröffentlichen von Ausgabedaten können die folgenden Aktivitäten darauf zugreifen.
Aktivitäten können einfach oder auch komplex sein. Sie können eine Aktivität mithilfe des Befehlszeilenaktivitäts-Assistenten erstellen, der einfach Text an eine Ausgabeeigenschaft übergibt. Sie können auch eine einzelne Aktivität erstellen, die eine komplexe, mehrstufige Aktion wie die Bereitstellung virtueller Computer ausführt. Sie können definieren, was jede Aktivität ausführt. Ihr Ziel sollte jedoch sein, Aktivitäten zu definieren, die einzelne Funktionssätze kapseln, um eine einfache Wiederverwendung in vielen verschiedenen Situationen zu ermöglichen. Der Schlüssel ist Flexibilität. Es ist besser, einen Satz von 10 verschiedenen Aktivitäten zu erstellen, die jeweils etwas spezifisches tun, und diese Aktivitäten auf 20 verschiedene Arten verwenden zu können, statt 20 verschiedene Aktivitäten zu erstellen, um die spezifischen einzelnen Szenarien zu lösen. Weitere Informationen zu bewährten Methoden werden weiter unten in diesem Dokument behandelt.
Erstellen einer neuen Aktivitätsassembly
Führen Sie die folgenden Schritte aus, um eine neue Befehlszeilenaktivitätsassembly zu erstellen:
Wählen Sie Start > Alle Programme > Microsoft System Center 2012 > Orchestrator > Integration Toolkit > Befehlszeilenaktivitäts-Assistent in Orchestrator aus.
Wählen Sie Weiter aus.
Geben Sie auf der Seite Assemblydetails einen Wert für Name ein, der mit einem Buchstaben beginnt, auf den null oder mehrere alphanumerische Zeichen folgen. Dieser Name wird als C#-Namespacebezeichner für die Assembly und Ihre Aktivitäten verwendet.
Geben Sie in der Assemblydatei einen Pfad und Dateinamen der Assemblydatei ein, die von diesem Assistenten erstellt wird. Wenn diese Datei bereits vorhanden ist, werden Sie aufgefordert, die Datei zu überschreiben.
Wählen Sie Assemblyinformationen aus. Hier können Sie Informationen eingeben, die zu den Eigenschaften der Assemblydatei werden, die über die Dateieigenschaften im Windows-Explorer sichtbar sind. Die Eigenschaftswerte werden in der folgenden Tabelle definiert. Diese Informationen sind optional und nicht erforderlich, um eine Assembly zu erstellen.
Eigenschaft Beschreibung Position Gibt einen Titel für die Assembly an, der als die Eigenschaft Dateibeschreibung in den Windows Explorer-Eigenschaften angezeigt wird. Beschreibung Gibt eine optionale Beschreibung für die Assembly an, die in den Windows-Explorer-Eigenschaften nicht angezeigt wird. Produkt Gibt einen Produktnamen für die Assembly an, der als Eigenschaft Produktname in den Windows-Explorer-Eigenschaften angezeigt wird. Firma Gibt einen Firmennamen für die Assembly an, der in den Windows-Explorer-Eigenschaften nicht angezeigt wird. Copyright Gibt einen Copyrighthinweis für die Assembly an, der als Copyright in den Windows-Explorer-Eigenschaften angezeigt wird. Marke Gibt eine Marke für die Assembly an, die als Rechtliche Marken in den Windows Explorer-Eigenschaften angezeigt wird. Version Gibt die Assembly- und Dateiversion an. Diese werden in den Windows Explorer-Eigenschaften als Dateiversion und Produktversion angezeigt.
Die Versionsnummer weist die folgenden vier Teile auf:
<Hauptversion>.<Nebenversion>.<Buildnummer>.<Revision>Wählen Sie OK aus, wenn Sie die Assemblyinformationen eingegeben haben.
Wählen Sie Weiter aus. Die Seite Befehle wird angezeigt.
Fügen Sie einen oder mehrere Befehle hinzu, indem Sie den Anweisungen in Hinzufügen von Befehlen zu einer Assembly folgen.
Wenn Sie die Definition Ihrer Aktivität abgeschlossen haben, wählen Sie OK aus. Das Dialogfeld wird geschlossen, und Ihre neue Aktivität wird der Liste auf der Seite Befehle hinzugefügt. Wenn Sie zurückgehen und einen Befehl bearbeiten müssen, wählen Sie den Befehl in der Liste und dann „Bearbeiten“ aus. Wenn Sie einen Befehl löschen müssen, wählen Sie den Befehl in der Liste aus, und wählen Sie Entfernen aus.
Wenn Sie mit dem Hinzufügen und Ändern von Befehlen fertig sind, wählen Sie Weiter aus. Die Assemblydatei, die am Anfang des Assistenten angegeben wird, wird kompiliert. Wenn der Prozess abgeschlossen ist, wird die letzte Seite des Assistenten angezeigt.
Wenn Sie sofort ein Integrationspaket aus dieser neuen Assembly erstellen möchten, wählen Sie die Schaltfläche Integrationspaket erstellen aus. So wird der Integrationspaket-Assistent gestartet und die Informationen aus der Assembly werden geladen. Befolgen Sie dann die Anweisungen in Erstellen eines neuen Integrationspakets, um das Integrationspaket zu erstellen.
Wenn Sie Ihre Assembly mit der Aktivität „Invoke .NET“ testen oder den IP-Buildprozess zunächst überspringen möchten, wählen Sie Fertigstellen aus.
Hinzufügen von Befehlen zu einer Assembly
Führen Sie die folgenden Schritte aus, um einer Assembly einen Befehl hinzuzufügen:
Auf der Seite Befehle können Sie einen oder mehrere Befehle (die zu Aktivitäten werden) definieren, die der Assembly hinzugefügt werden. Wählen Sie Hinzufügen aus, um einen neuen Befehl hinzuzufügen.
Das Dialogfeld Befehl hinzufügen/bearbeiten wird angezeigt und enthält drei Registerkarten: Allgemein, Argumente und Veröffentlichte Daten. Geben Sie einen Namen für den Befehl ein. Dies wird der Name, der für die Aktivität im Runbook-Designer angezeigt wird. Optional können Sie auch eine Beschreibung für den Befehl eingeben.
Die Auswahl der Eigenschaft Modus enthält vier Optionen: „Befehl ausführen“, „Windows PowerShell ausführen“, „Programm ausführen“ und „SSH-Befehl ausführen“. Wenn Sie den Modus Programm ausführen ausgewählt haben, wird das Feld Programm aktiviert. Wählen Sie die Schaltfläche mit den Auslassungspunkten (...) aus und suchen Sie nach dem Programm, das Sie ausführen möchten.
Hinweis
Das in einem Befehl „Programm ausführen“ ausgewählte Programm wird auf dem Runbookserver aufgerufen, auf dem das Runbook ausgeführt wird, das diese Aktivität enthält. Daher muss dieses Programm auf allen Runbookservern vorhanden sein, auf denen Sie das Runbook ausführen möchten.
Wählen Sie die Registerkarte Argumente aus.
Geben Sie im Feld Befehlszeile die von Ihrer Aktivität benötigten Befehls- oder Befehlszeilenparameter ein. Wenn Ihr Befehl Parameter verwendet, die Benutzer angeben sollen, müssen Sie sie in der nachstehenden Liste Parameter hinzufügen und dann die Schaltfläche Einfügen verwenden, um sie der Befehlszeile hinzuzufügen.
Wichtig
Wenn Sie Windows PowerShell ausführen für den Modus angegeben haben und auf ein PowerShell-Skript verweisen, das in Ihrem Integrationspaket enthalten ist, müssen Sie dem Namen des Skripts Punkt- und Schrägstrichzeichen voranstellen, um auf das lokale Verzeichnis zu verweisen. „.\MyScript.ps1“ wird beispielsweise für ein Skript mit dem Namen „MyScript.ps1“ angegeben. Dies liegt daran, dass die Skriptdatei in das Standardverzeichnis für das Integrationspaket kopiert wird. Wenn Windows PowerShell ein Skript aus dem lokalen Verzeichnis ausführt, muss diese Notation angegeben werden.
Um Parameter für eine Befehlszeile bereitzustellen, wählen Sie Hinzufügen aus. Das Dialogfeld Parameter hinzufügen/bearbeiten wird angezeigt.
Geben Sie im Feld „Name“ einen Namen für den Parameter ein, den Sie hinzufügen. Dies ist der Anzeigename des Parameters, der in der Liste „Eigenschaften“ der Aktivität angezeigt wird.
Wählen Sie in der Dropdownliste „Verwendungsmodus“ den Modus aus, den Sie für den Parameter verwenden möchten. Für den Verwendungsmodus gibt es zwei Optionen:
Verwendungsmodus Beschreibung Befehlsargument Wählen Sie dieses Argument als Parameter in Ihrer Befehlszeile aus (über die Schaltfläche Einfügen). Zum Beispiel könnte ein Befehlsargumentparameter namens „Ordner“ in der Befehlszeile wie folgt platziert werden:
Dir $(folder)
Hinweis: Wenn Befehlszeilenargumente Leerzeichen enthalten (z. B. Ordnernamen), müssen Sie diese möglicherweise in Anführungszeichen setzen, damit der Befehl ordnungsgemäß funktioniert. Beispiel:Dir "$(folder)"
Umgebungsvariable Wählen Sie diese Option aus, um dieses Argument als Umgebungsvariable zu verwenden, die vor der Ausführung der Befehlszeile festgelegt wird. Sie kann als Befehlszeilenparameter oder als Umgebungsvariable innerhalb eines ausgeführten Skripts verwendet werden.
Ein Umgebungsvariablenparameter mit dem Namen „Ordner“ könnte beispielsweise wie folgt in die Befehlszeile eingefügt werden:
Dir %Folder%
Wichtig: Der Name der Umgebungsvariablen existiert bereits in der Benutzer- oder Systemumgebung. Der Befehl schlägt fehl und es wird eine Fehlermeldung ähnlich der Folgenden angezeigt: Element wurde bereits hinzugefügt. Schlüssel im Wörterbuch: „Ordner“, Schlüssel wird hinzugefügt: „Ordner“. Sie können feststellen, welche Umgebungsvariablen auf einem lokalen oder Remotecomputer vorhanden sind, indem Sie Start > Ausführen auswählen undMSINFO32.EXE
eingeben. Wählen Sie dann Software-Umgebung > Umgebungsvariablen. Um einen anderen Computer auszuwählen, drücken Sie <STRG+R>, wählen Sie Remotecomputer im Netzwerk aus, geben Sie den Computernamen ein und wählen Sie OK aus.Wählen Sie aus der Dropdownliste Anzeigestil den Stil aus, den Sie zur Anzeige des Parameters verwenden möchten. Der Anzeigestil bestimmt, wie die Benutzenden mit den Eingaben interagieren, wenn sie ihnen angezeigt werden. Die Optionen werden im Folgenden beschrieben:
Anzeigestil Beschreibung Text Den Benutzenden wird ein Freitextfeld zur Eingabe eines Wertes angezeigt. Encrypted Text Den Benutzenden wird ein maskiertes Textfeld angezeigt. Die Daten in diesem Feld werden innerhalb der Datenbank verschlüsselt und werden in keinem Protokoll angezeigt. True/False Die Benutzenden können in einem Pop-up-Dialogfeld „True“ (wahr) oder „False“ (falsch) auswählen. Text with Selection Die Benutzenden können aus einer Gruppe von Optionen auswählen, die Sie festlegen. Date/Time Die Benutzenden können den Wert mithilfe eines Datums-/Zeitauswahl-Steuerelements auswählen. Datei Die Benutzenden können den Wert mithilfe eines Dateibrowser-Steuerelements auswählen. Ordner Die Benutzenden können den Wert mithilfe eines Ordner-Browser-Steuerelements auswählen. Computer Die Benutzenden können den Wert mithilfe eines Computerbrowser-Steuerelements auswählen. Wenn der Parameter einen Standardwert erfordert oder Sie einen Standardwert angeben möchten, geben Sie diesen in das Feld Standardwert ein.
Wenn Sie Text mit Auswahl gewählt haben, ist das Feld Optionen aktiviert. Um Optionswerte hinzuzufügen, aus denen die Benutzenden auswählen können, wählen Sie die Schaltfläche mit den drei Punkten neben dem Feld Optionen aus und geben Sie sie ein. Jede Option wird in einer separaten Zeile aufgeführt. Wenn Sie alle Optionen hinzugefügt haben, wählen Sie OK.
Wenn Sie mit der Parameterdefinition fertig sind, wählen Sie OK.
Wenn der Parameter als Befehlsparameter definiert ist, kann er nun zur Befehlszeile hinzugefügt werden, indem der Cursor an der gewünschten Einfügemarke in der Befehlszeile platziert wird, dann die Schaltfläche Einfügen ausgewählt und der Parametername ausgewählt wird. Wenn er als Umgebungsvariable definiert ist, müssen Sie die Variable manuell eingeben (im Format %variable%), wenn Sie sie in der Befehlszeile verwenden möchten.
Wenn Sie den Modus Programm ausführen oder Befehlszeile ausführen gewählt haben, ist das Kontrollkästchen für Arbeitsverzeichnis-Parameter einbeziehen aktiviert.
Wählen Sie die Registerkarte Veröffentlichte Daten aus. Mit den Einstellungen auf dieser Registerkarte können Sie Ausgabedaten auf dem Orchestrator-Datenbus veröffentlichen, damit andere Aktivitäten die Informationen nutzen können.
Um eine neue veröffentlichte Dateneigenschaft hinzuzufügen, wählen Sie Hinzufügen.
Wenn Sie die Option Befehl ausführen, Programm ausführen oder SSH-Befehl ausführen aus der Dropdownliste Modus auf der Registerkarte Allgemein des Dialogs Befehl hinzufügen/bearbeiten ausgewählt haben, erscheinen die folgenden Elemente im Dialogfeld Veröffentlichte Daten hinzufügen/bearbeiten:
Elemente Beschreibung Name Der Anzeigename des Elements „Veröffentlichte Daten“, das Sie erstellen Quelle Die Quelle des Elements „Veröffentlichte Daten“. Sie können in der Befehlszeile zwischen Standardausgabedatenstream oder Standardfehlerstream auswählen. Mode Der Modus, den Sie zum Auswählen der veröffentlichten Daten verwenden möchten.
Verwenden Sie Muster abgleichen, um zu ermitteln, ob ein bestimmtes Muster in der Quelle gefunden wird. Damit wird True oder False zurückgegeben.
Verwenden Sie Gruppe extrahieren, um alle Datenelemente abzurufen, die dem von Ihnen angegebenen Muster entsprechen.Muster Der reguläre Ausdruck, der für die Einstellung „Modus“ gilt Beschreibung Der Beschreibungstext, der neben der veröffentlichten Dateneigenschaft im Runbook-Designer angezeigt wird. (Optional) Wenn Sie die Option Windows PowerShell ausführen in der Dropdownliste Modus auf der Registerkarte Allgemein des Dialogfelds Befehl hinzufügen/bearbeiten ausgewählt haben, werden die folgenden Elemente im Dialogfeld Veröffentlichte Daten hinzufügen/bearbeiten angezeigt:
Elemente Beschreibung Name Der Anzeigename des Elements „Veröffentlichte Daten“, das Sie erstellen Eigenschaft Der Name der Windows PowerShell-Eigenschaft, die im Element „Veröffentlichte Daten“ gespeichert wird. Diese Eigenschaft muss in einer Objektausgabe in der PowerShell-Pipeline während der Skriptausführung enthalten sein und darf kein Objekt sein (sollte in eine Zeichenfolge konvertiert werden können). Beschreibung Der Beschreibungstext, der neben der veröffentlichten Dateneigenschaft im Runbook-Designer angezeigt wird. (Optional) Wählen Sie OK aus, um das Hinzufügen des Elements „Veröffentlichte Daten“ abzuschließen. Wiederholen Sie die Schritte 16 bis 18 für jedes Element „Veröffentlichte Daten“, das Sie hinzufügen möchten.
Wählen Sie OK aus, um das Dialogfeld „Befehl hinzufügen/bearbeiten“ zu schließen und zum Dialogfeld „Befehle“ zurückzukehren.
Testen einer Aktivitätsassembly
Nachdem Sie eine Assembly erstellt haben, können Sie sie mithilfe der Aktivität „.NET aufrufen“ testen (enthalten in Integration Toolkit IP für .NET), um zu überprüfen, ob sie wie erwartet funktioniert, bevor Sie sie in ein benutzerdefiniertes Integrationspaket konvertieren.
Testen einer Assembly
Führen Sie zum Testen einer Assembly folgenden Schritte aus:
Öffnen Sie den Runbook-Designer.
Erstellen Sie ein neues Runbook.
Wählen Sie im Bereich Aktivitäten die Kategorie Integration Toolkit aus, um sie zu erweitern, und ziehen Sie eine Aktivität .NET aufrufen in das neue Runbook.
Doppelklicken Sie auf das Objekt „.NET aufrufen“, um das Dialogfeld Eigenschaften anzuzeigen.
Suchen Sie im Feld Assembly nach der Assemblydatei, die Sie mit dem Befehlszeilenaktivitäts-Assistenten (oder über die benutzerdefinierte Entwicklung mithilfe des SDK) erstellt haben, indem Sie die Schaltfläche mit den Auslassungspunkten (...) rechts neben dem Feld auswählen. Wählen Sie die Datei und dann Öffnen aus.
Wählen Sie die Schaltfläche mit den Auslassungspunkten rechts neben dem Feld Klasse aus, um eine Liste der einzelnen Befehle in der Assembly anzuzeigen. Wählen Sie eine Befehlsklasse aus, und wählen Sie OK aus. Parameter für diese Klasse werden auf der Registerkarte Eigenschaften des Dialogfelds angezeigt.
Das Feld Setup wird nur von benutzerdefinierten Klassen verwendet, die das Orchestrator SDK mit dem OrchestratorData-Attribut verwenden. Weitere Informationen zum SDK finden Sie unter System Center Orchestrator Integration Toolkit SDK.
Klicken Sie auf die Registerkarte Eigenschaften.
Geben Sie die Informationen für alle Eigenschaften nach Bedarf an.
Wählen Sie Fertig stellen aus, um die Einstellungen zu speichern und zum Runbook zurückzukehren.
Wählen Sie Runbook Tester auf der Symbolleiste im Runbook-Designer aus. Der Runbook Tester wird gestartet.
Wählen Sie auf der Symbolleiste Bis Haltepunkt ausführen aus. Das Runbook wird gestartet, und Ihre Aktivität wird ausgeführt. Die Ergebnisse der Aktivität werden im Bereich Ausführungsprotokoll angezeigt.
Wählen Sie Show Details im Bereich „Ausführungsprotokoll“ unter dem Namen der Aktivität aus, um die detaillierten Ergebnisse anzuzeigen, einschließlich der Eingabeeigenschaften und veröffentlichten Daten.
QIK CLI Activity Migration
Wenn Sie eine Assembly haben, die mit dem Opalis 6.3 QIK CLI Wizard erstellt wurde, müssen Sie sie konvertieren, damit sie mit Orchestrator kompatibel ist, bevor sie entweder in einem Orchestrator Integration Pack oder direkt in Runbooks über die Invoke .NET-Aktivität verwendet werden kann. Der Konvertierungsprozess ist einfach und dauert nur ein paar Sekunden pro Assembly.
Wichtig
Die Installation des Orchestrator Integration Toolkit schlägt nicht fehl, wenn Microsoft .NET Framework 3.5, Service Pack 1 nicht installiert ist, aber verschiedene Vorgänge im Assistenten für Befehlszeilenaktivitäten schlagen fehl, wenn es nicht vorhanden ist. Stellen Sie sicher, dass Microsoft .NET Framework 3.5, Service Pack 1 installiert ist, bevor Sie die CLI verwenden.
Convert an Opalis QIK CLI Assembly
Führen Sie die folgenden Schritte aus, um eine Opalis QIK CLI-Assembly zu konvertieren:
Starten Sie den Orchestrator-Befehlszeilen-Aktivitätsassistenten, indem Sie Folgendes auswählen: Start > Alle Programme > Microsoft System Center 2012 > Orchestrator > Befehlszeilen-Aktivitätsassistent
Wenn der Assistent geladen wird, wählen Sie auf der ersten Seite die Schaltfläche Vorhandene Assembly laden.
Markieren Sie Ihre vorhandene Assembly-Datei und wählen Sie dann Öffnen. Der Name und der Speicherort der Assembly werden angezeigt.
Ändern Sie den Dateipfad, damit die Änderungen in einer neuen Datei gespeichert werden. Sie können den Namen der Assembly auch bei Bedarf ändern.
Wenn Sie weitere Änderungen an den Details der Assembly-Informationen vornehmen müssen, wählen Sie die Schaltfläche Assemblyinformationen und nehmen Sie diese Änderungen vor. Wählen Sie anschließend OK, um zur Seite der Assemblydetails zurückzukehren.
Wählen Sie Weiter, um zur Befehlsseite zu gelangen. Es sollte eine Liste der Befehle angezeigt werden, die zuvor in der Assembly definiert wurden. Überprüfen Sie die Befehle, falls erforderlich, und wählen Sie Weiter, um zur Seite Building Assembly zu gelangen.
Die neue Assembly wird für Sie erstellt und mithilfe des zuvor definierten Pfads und Dateinamens gespeichert.
Sie können Ihre neue Orchestrator-kompatible Assembly jetzt in Runbooks mit der Invoke .NET-Aktivität verwenden oder ein Integrationspaket aus dieser Assembly erstellen, indem Sie auf die Schaltfläche Build Integration Pack klicken. Wenn Sie zu diesem Zeitpunkt keine IP erstellen möchten, wählen Sie Schließen, um den Assistenten zu beenden.
Orchestrator-Ressourcen
Zusätzlich zu dieser Online-Referenz für System Center 2012 Orchestrator gibt es eine Reihe von Ressourcen, die zusätzliche Informationen zur Erstellung von Runbooks, zur Verwendung des Integration Toolkit und zu Best Practices bieten.