Befehlszeilenaktivitäts-Assistent
Wichtig
Diese Version von Orchestrator hat das Ende des Supports erreicht. Es wird empfohlen, ein Upgrade auf Orchestrator 2019 durchzuführen.
Mit dem Befehlszeilenaktivitäts-Assistenten können Sie schnell neue Aktivitäten in Orchestrator erstellen, indem Sie Befehle, Argumente und Parameter in einer Microsoft .NET-Assembly (DLL) kapseln. Der Assistent erstellt automatisch C#-Quellcode mithilfe des Orchestrator-SDK und kompiliert ihn für Sie. Mit dieser Assembly können Sie das .NET Integration Pack (Teil des Integration Toolkits) verwenden, um Ihre Aktivitäten zu testen, und dann den Integrationspaket-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 einem oder mehreren der verfügbaren Befehlstypen (Befehl, Befehlszeile, PowerShell- oder SSH-Befehl) entsprechen. Sie definieren den Aktivitätsnamen, die Befehlsstruktur, die 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 tatsächlichen Aufgaben in Runbooks und werden mithilfe von Links verknüpft, die mit Bedingungen zum Erstellen von Workflowbranches definiert werden können. Wenn Sie ein Runbook mithilfe des Runbook Designer erstellen, ziehen Sie Aktivitäten aus dem Bereich Aktivitäten in das Runbook und verknüpfen sie dann, um den Workflow zu bilden. Während das Runbook ausgeführt wird, ruft es jede Aktivität nacheinander 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 ihre Ausgabe im gleichen Datenbus veröffentlichen. Jede Aktivität kann veröffentlichte Daten aus allen Aktivitäten zeichnen, die zuvor im Runbook ausgeführt wurden, und die Veröffentlichung von Ausgabedaten ermöglicht es folgenden Aktivitäten, darauf zuzugreifen.
Die Aktivitäten reichen von sehr einfach bis sehr komplex. Sie können eine Aktivität mit dem Command-Line-Aktivitäts-Assistenten erstellen, der nur Text an eine Ausgabeeigenschaft zurückgibt. Sie können auch eine einzelne Aktivität erstellen, die eine komplexe, mehrstufige Aktion wie die Bereitstellung virtueller Computer ausführt. Es ’ liegt an Ihnen, zu definieren, was die einzelnen Aktivitäten tun. Ihr Ziel sollte es jedoch sein, Aktivitäten zu definieren, die einzelne Sätze von Funktionen kapseln, die eine einfache Wiederverwendung in vielen verschiedenen Arten von Situationen ermöglichen. Der Schlüssel ist Flexibilität. Es ist ’ besser, einen Satz von zehn verschiedenen Aktivitäten zu erstellen, die jeweils etwas bestimmtes tun, und diese Aktivitäten auf 20 verschiedene Arten verwenden zu können, anstatt 20 verschiedene Aktivitäten zu erstellen, um die spezifischen individuellen Szenarien zu lösen. Weitere Informationen zu bewährten Methoden werden weiter unten in diesem Dokument behandelt.
Erstellen einer neuen Aktivitätsassembly
So erstellen Sie eine neue Befehlszeilenaktivitätsassembly
Klicken Sie auf Start All Programs Microsoft System Center > 2012 > Orchestrator Integration Toolkit >> Orchestrator Command-Line Activity Wizard
Klicken Sie auf Weiter.
Geben Sie auf der Seite Assemblydetails einen Wert für Name ein, der mit einem Buchstaben beginnt und auf den null oder mehr alphanumerische Zeichen folgen. Dieser Name wird als C#-Namespacebezeichner für die Assembly und Ihre Aktivitäten verwendet.
Geben Sie in Assemblydateieinen Pfad und Dateinamen der Assemblydatei ein, die von diesem Assistenten erstellt werden. Wenn diese Datei bereits vorhanden ist, werden Sie aufgefordert, die Datei zu überschreiben.
Klicken Sie auf die Schaltfläche Assemblyinformationen. Sie können hier Informationen eingeben, die zu den Eigenschaften der Assemblydatei werden, die in Windows Explorer über Dateieigenschaften sichtbar werden. Die Eigenschaftswerte werden in der folgenden Tabelle definiert. Diese Informationen sind optional und nicht erforderlich, um eine Assembly zu erstellen.
Eigenschaft BESCHREIBUNG Titel Gibt einen Titel für die Assembly an, der als “ Eigenschaft Dateibeschreibung in Windows Explorer-Eigenschaften angezeigt wird. ” BESCHREIBUNG Gibt eine optionale Beschreibung für die Assembly an, die nicht in Windows Explorer-Eigenschaften angezeigt wird. Product Gibt einen Produktnamen für die Assembly an, der als “” Product name-Eigenschaft in Windows Explorer-Eigenschaften angezeigt wird. Company Gibt einen Unternehmensnamen für die Assembly an, der nicht in Windows Explorer-Eigenschaften angezeigt wird. Copyright Gibt einen Urheberrechtshinweis für die Assembly an, der “ in Windows Explorer-Eigenschaften als Copyright angezeigt wird. ” Marke Gibt eine Marke für die Assembly an, die “ in Windows Explorer-Eigenschaften als rechtliche Marken angezeigt wird. ” Version Gibt die Assemblyversion und dateiversion an. Diese werden in Windows Explorer-Eigenschaften als Dateiversion und Produktversionangezeigt.
Die Versionsnummer enthält vier Teile:
<Hauptversion > . < Nebenversion > . < Buildnummer > . < Revision>Klicken Sie auf OK, wenn Sie die Eingabe von Assemblyinformationen abgeschlossen haben.
Klicken Sie auf Weiter. Die Seite Befehle wird angezeigt.
Fügen Sie mindestens einen Befehl hinzu, indem Sie die Anweisungen unter Hinzufügen von Befehlen zu einer Assemblybefolgen.
Wenn Sie die Definition Ihrer Aktivität abgeschlossen haben, klicken Sie auf OK. Das Dialogfeld wird geschlossen, und Ihre neue Aktivität wird der Liste auf der Seite Befehle hinzugefügt. Wenn Sie einen Befehl bearbeiten müssen, wählen Sie den Befehl in der Liste aus, und klicken Sie auf Bearbeiten. Wenn Sie einen Befehl löschen müssen, wählen Sie den Befehl in der Liste aus, und klicken Sie auf Entfernen.
Wenn Sie mit dem Hinzufügen und Ändern von Befehlen fertig sind, klicken Sie auf Weiter. Die Assemblydatei, die zu Beginn des Assistenten angegeben wurde, wird kompiliert, und wenn der Prozess abgeschlossen ist, wird die letzte Assistentenseite angezeigt.
Wenn Sie sofort ein Integrationspaket aus dieser neuen Assembly erstellen möchten, klicken Sie auf die Schaltfläche Integrationspaket erstellen, um den Integrationspaket-Assistenten zu starten und die Informationen vorab aus der Assembly zu laden. Befolgen Sie dann die Anweisungen unter Erstellen eines neuen Integrationspakets, um das Integrationspaket zu erstellen.
Wenn Sie Ihre Assembly mithilfe der Aktivität .NET aufrufen testen oder den IP-Buildprozess vorerst überspringen möchten, klicken Sie auf Fertig stellen.
Hinzufügen von Befehlen zu einer Assembly
So fügen Sie einer Assembly einen Befehl hinzu
Auf der Seite Befehle können Sie einen oder mehrere Befehle definieren (die zu Aktivitäten werden), die der Assembly hinzugefügt werden. Klicken Sie auf Hinzufügen,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 im Runbook Designer für die Aktivität angezeigt wird. Optional können Sie auch eine Beschreibung für den Befehl eingeben.
Der Eigenschaftenselektor Mode enthält vier Optionen: Skriptausführung, 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 aktiv. Klicken Sie auf die Schaltfläche mit den Auslassungszeichen (...), 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 Runbook-Server 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.
Klicken Sie auf die Registerkarte Argumente.
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 folgenden Parameterliste hinzufügen und dann die Schaltfläche Einfügen verwenden, um sie der Befehlszeile hinzuzufügen.
Wichtig
Wenn Sie run Windows PowerShell für mode 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 vorangestellt haben, um auf das lokale Verzeichnis zu verweisen. Beispielsweise wird .\MyScript.ps1 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.
Klicken Sie auf Hinzufügen,um Parameter für eine Befehlszeile bereitzustellen. 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 Nutzungsmodus den Modus aus, den Sie für den Parameter verwenden möchten. Der Nutzungsmodus hat zwei Möglichkeiten:
Nutzungsmodus BESCHREIBUNG Command-Argument Wählen Sie diese Option aus, um dieses Argument als Parameter in der Befehlszeile zu verwenden (mithilfe der Schaltfläche Einfügen). Beispielsweise könnte ein Befehlsargumentparameter mit dem Namen “ Folder in der Befehlszeile wie folgt platziert ” werden:
Dir $(folder)Dir $(folder)Wenn Befehlszeilenargumente Leerzeichen (z. B. Ordnernamen) enthalten, müssen Sie sie möglicherweise in Anführungszeichen einschließen, damit der Befehl ordnungsgemäß funktioniert. Beispiel:Dir "$(folder)"Umgebungsvariable Wählen Sie diese Option aus, um dieses Argument als Umgebungsvariable zu verwenden, die festgelegt wird, bevor die Befehlszeile ausgeführt wird. Sie kann als Befehlszeilenparameter oder als Umgebungsvariable in einem ausgeführten Skript verwendet werden.
Beispielsweise könnte ein Umgebungsvariablenparameter mit dem Namen “ Folder in der Befehlszeile wie folgt platziert ” werden:
Dir %Folder%Dir %Folder%Der Umgebungsvariablenname ist bereits in Benutzer- oder Systemumgebungen vorhanden. Der Befehl schlägt mit einer Fehlermeldung wie der folgenden fehl: Element wurde bereits hinzugefügt. Schlüssel im Wörterbuch: "Ordner"Schlüssel hinzugefügt: "Ordner" Sie können ermitteln, welche Umgebungsvariablen auf einem lokalen oder Remotecomputer vorhanden sind, indem Sie auf Ausführen startenklicken und dann eingeben. Wählen Sie dann Softwareumgebungsumgebungsvariablenaus. Um einen anderen Computer auszuwählen, drücken Sie STRG+R, >wählen Sie > aus, geben Sie den Computernamen ein, und klicken Sie dann auf OK.Wählen Sie in der Dropdownliste Anzeigestil den Stil aus, den Sie zum Anzeigen des Parameters verwenden möchten. Der Anzeigestil bestimmt, wie der Benutzer mit der Eingabe interagiert, wenn sie angezeigt wird. Die Auswahlmöglichkeiten werden unten beschrieben:
Anzeigestil BESCHREIBUNG Text Dem Benutzer wird ein Freiformtextfeld für die Eingabe eines Werts angezeigt. Verschlüsselter Text Dem Benutzer wird ein maskiertes Textfeld angezeigt. Die Daten in diesem Feld werden innerhalb der Datenbank verschlüsselt und nicht in Protokollen angezeigt. TRUE/FALSE Der Benutzer kann in einem Popupdialogfeld "True" oder "False" auswählen. Text mit Auswahl Der Benutzer kann aus einer Gruppe von Optionen auswählen, die Sie angeben. Datum/Uhrzeit Der Benutzer kann den Wert mithilfe eines Steuerelements für die Datums-/Uhrzeitauswahl auswählen. Datei Der Benutzer kann den Wert mithilfe eines Dateibrowser-Steuerelements auswählen. Ordner Der Benutzer kann den Wert mithilfe eines Ordnerbrowser-Steuerelements auswählen. Computer Der Benutzer kann den Wert mithilfe eines Computerbrowser-Steuerelements auswählen. Wenn der Parameter erforderlich ist oder Sie einen Standardwert angeben möchten, geben Sie ihn in das Feld Standardwert ein.
Wenn Sie Text mit Auswahlausgewählt haben, ist das Feld Optionen aktiviert. Um Optionswerte hinzuzufügen, aus denen der Benutzer auswählen kann, klicken Sie neben dem Feld Optionen auf die Schaltfläche mit den Auslassungszeichen, und geben Sie sie ein. Jede Option ist in einer separaten Zeile aufgeführt. Klicken Sie nach abschluss des Hinzufügens der Optionen auf OK.
Wenn Sie mit der Parameterdefinition fertig sind, klicken Sie auf OK.
Wenn er als Befehlsparameterdefiniert ist, kann der Parameter jetzt der Befehlszeile hinzugefügt werden, indem der Cursor an der gewünschten Einfügemarke in der Befehlszeile platziert wird. Klicken Sie anschließend auf die Schaltfläche Einfügen, und wählen Sie den Parameternamen aus. Wenn sie als Umgebungsvariabledefiniert 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 Skriptausführung Line ausgewählt haben, ist das Kontrollkästchen für Den Arbeitsverzeichnisparameter einschließen aktiviert.
Klicken Sie auf die Registerkarte Veröffentlichte Daten. Einstellungen auf dieser Registerkarte können Sie Ausgabedaten im Orchestrator-Datenbus veröffentlichen, damit andere Aktivitäten die Informationen verwenden können.
Klicken Sie auf Hinzufügen,um eine neue veröffentlichte Dateneigenschaft hinzuzufügen.
Wenn Sie die Option Skriptausführung, Programm ausführenoder SSH-Befehl ausführen in der Dropdownliste Modus auf der Registerkarte Allgemein des Dialogfelds Befehl hinzufügen/bearbeiten ausgewählt haben, werden im Dialogfeld Veröffentlichte Daten hinzufügen/bearbeiten die folgenden Elemente angezeigt:
Elemente BESCHREIBUNG Name Der Anzeigename des veröffentlichten Datenelements, das Sie erstellen. Quelle Die Quelle des Veröffentlichten Datenelements. Sie können über die Befehlszeile zwischen Standardausgabestream oder Standardfehlerstream auswählen. Modus Der Modus, den Sie zum Auswählen der veröffentlichten Daten verwenden möchten.
Verwenden Sie Übereinstimmungsmuster, um zu bestimmen, ob ein bestimmtes Muster in der Quelle gefunden wird. Dadurch wird True oder Falsezurückgegeben.
Verwenden Sie Gruppe extrahieren, um jedes Datenelement abzurufen, das dem von Ihnen angegebenen Muster entspricht.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 im Dialogfeld Befehl hinzufügen/bearbeiten in der Dropdownliste Modus auf der Registerkarte Allgemein die Option Windows PowerShell ausführen ausgewählt haben, werden im Dialogfeld Veröffentlichte Daten hinzufügen/bearbeiten die folgenden Elemente angezeigt:
Elemente BESCHREIBUNG Name Der Anzeigename des veröffentlichten Datenelements, das Sie erstellen. Eigenschaft Der Name der Windows PowerShell Eigenschaft, die im Element Veröffentlichte Daten gespeichert wird. Diese Eigenschaft muss während des Skripts in einer Objektausgabe an die PowerShell-Pipeline 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) Klicken Sie auf OK, um das Hinzufügen des Veröffentlichten Datenelements abzuschließen. Wiederholen Sie die Schritte 16 bis 18 für jedes veröffentlichte Datenelement, das Sie hinzufügen möchten.
Klicken Sie auf OK, 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 .NET-Aktivität aufrufen (die in der Integration Toolkit-IP für .NET enthalten ist) testen, um zu überprüfen, ob sie erwartungsgemäß funktioniert, bevor Sie sie in ein benutzerdefiniertes Integrationspaket konvertieren.
So testen Sie und assembly
Öffnen Sie die Runbook Designer.
Erstellen Sie ein neues Runbook.
Klicken Sie im Bereich Aktivitäten auf die Kategorie Integration Toolkit, um sie zu erweitern, und ziehen Sie eine Invoke .NET-Aktivität 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 Command-Line-Aktivitäts-Assistenten (oder über die benutzerdefinierte Entwicklung mit dem SDK) erstellt haben, indem Sie rechts neben dem Feld auf die Schaltfläche mit den Auslassungszeichen (...) klicken. Wählen Sie die Datei aus, und klicken Sie dann auf Öffnen.
Klicken Sie rechts neben dem Feld Klasse auf die Schaltfläche mit den Auslassungszeichen, um eine Liste der einzelnen Befehle in der Assembly anzuzeigen. Wählen Sie eine Befehlsklasse aus, und klicken Sie auf OK. Parameter für diese Klasse werden im Dialogfeld auf der Registerkarte Eigenschaften 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 jede der Eigenschaften nach Bedarf an.
Klicken Sie auf Fertig stellen, um die Einstellungen zu speichern und zum Runbook zurückzukehren.
Klicken Sie in der Symbolleiste des Runbook Designer auf Runbook Tester. Die Runbook Tester wird gestartet.
Klicken Sie auf der Symbolleiste auf Bis Haltepunkt ausführen. Das Runbook wird gestartet, und Ihre Aktivität wird ausgeführt. Die Ergebnisse der Aktivität werden im Bereich Protokoll ausführen angezeigt.
Klicken Sie im Bereich Ausführungsprotokoll unter dem Aktivitätsnamen auf Details anzeigen, um die detaillierten Ergebnisse anzuzeigen, einschließlich der Eingabeeigenschaften und veröffentlichten Daten.
QIK CLI-Aktivitätsmigration
Wenn Sie über eine Assembly verfügen, die mit dem Opalis 6.3 QIK CLI-Assistenten 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 wenige Sekunden pro Assembly.
Wichtig
Die Installation für die Orchestrator Integration Toolkit ist nicht fehlgeschlagen, wenn Microsoft .NET Framework 3.5, Service Pack 1 nicht installiert ist, aber verschiedene Vorgänge im Command-Line-Aktivitäts-Assistenten fehlschlagen, wenn es nicht vorhanden ist. Stellen Sie sicher, dass Microsoft .NET Framework 3.5, Service Pack 1 installiert ist, bevor Sie die CLI verwenden.
So konvertieren Sie eine Opalis QIK-CLI-Assembly
Starten Sie den Orchestrator Command-Line-Aktivitäts-Assistenten, indem Sie auf Alle Programme >> starten System Center 2012 Orchestrator Command-Line >> Aktivitäts-Assistent klicken.
Wenn der Assistent geladen wird, klicken Sie auf der ersten Seite auf die Schaltfläche Vorhandene Assembly laden.
Wählen Sie Ihre vorhandene Assemblydatei aus, und klicken Sie dann auf Öffnen. Der Name und der Dateispeicherort der Assembly werden angezeigt.
Ändern Sie den Dateipfad so, dass die Änderungen in einer neuen Datei gespeichert werden. Sie können bei Bedarf auch den Namen der Assembly ändern.
Wenn Sie weitere Änderungen an den Assemblyinformationsdetails vornehmen müssen, klicken Sie auf die Schaltfläche Assemblyinformationen, und nehmen Sie diese Änderungen vor. Klicken Sie auf OK, wenn Sie fertig sind, um zur Seite Assemblydetails zurückzukehren.
Klicken Sie auf Weiter, um zur Seite Befehle zu wechseln. Es sollte eine Liste der Befehle angezeigt werden, die zuvor in der Assembly definiert wurden. Überprüfen Sie bei Bedarf die Befehle, und klicken Sie auf Weiter, um mit der Seite Assembly erstellen fortzufahren.
Die neue Assembly wird für Sie erstellt und unter Verwendung des zuvor definierten Pfads und Dateinamens gespeichert.
Sie können jetzt Ihre neue Orchestrator-kompatible Assembly in Runbooks mit der Aktivität .NET aufrufen verwenden, oder Sie können ein Integrationspaket aus dieser Assembly erstellen, indem Sie auf die Schaltfläche Integrationspaket erstellen klicken. Wenn Sie zu diesem Zeitpunkt keine IP-Adresse erstellen möchten, klicken Sie auf Schließen, um den Assistenten zu beenden.
Orchestrator-Ressourcen
Zusätzlich zu dieser Onlinereferenz für System Center 2012 Orchestrator gibt es eine Reihe von Ressourcen, die zusätzliche Informationen zum Erstellen von Runbooks, mithilfe des Integration Toolkits und bewährte Methoden bereitstellen können.
| Resource | Standort |
|---|---|
| System Center-Startseite | https://www.microsoft.com/en-us/cloud-platform/system-center |
| System Center dokumentation | https://docs.microsoft.com/system-center/ |
| Orchestrator-Teamblog auf TechNet | https://blogs.technet.microsoft.com/orchestrator/ |
| Orchestrator-Community-Foren auf TechNet | https://social.technet.microsoft.com/Forums/en-US/home?category=systemcenterorchestrator |