コマンド ライン アクティビティ ウィザード
重要
このバージョンの Orchestrator はサポート終了に達しました。 Orchestrator 2019 にアップグレードすることをお勧めします。
コマンド ライン アクティビティ ウィザードを使用すると、コマンド、引数、パラメーターを Microsoft .NET アセンブリ (.DLL) にカプセル化することで、Orchestrator で新しいアクティビティをすばやく作成できます。 このウィザードでは、Orchestrator SDK を使用して C# ソース コードが自動的に作成され、自動的にコンパイルされます。 このアセンブリを使用すると、.NET Integration Pack (Integration Toolkit の一部) を使用してアクティビティをテストし、統合パック ウィザードを使用して、他の統合パックと同様に配布および展開できるカスタム統合パックにアセンブリをパッケージ化できます。
アセンブリには 1 つ以上のアクティビティ (コマンド) を含めることができます。また、アクティビティには、使用可能なコマンドの種類 (コマンド、コマンド ライン、PowerShell、または SSH コマンド) を 1 つ以上指定できます。 アクティビティ名、コマンド構造、入力パラメーター、さらにはパブリッシュされたデータ (出力) を定義します。
Orchestrator のアクティビティの概要
アクティビティは、Orchestrator Runbook の 1 つの機能部分です。 アクティビティは Runbook 内で実際の作業を行うものであり、ワークフロー ブランチを作成するための条件で定義できるリンクを使用して結合されます。 Runbook デザイナーを使用して Runbook を構築する場合は、[アクティビティ] ウィンドウから Runbook にアクティビティをドラッグ アンド ドロップし、それらをリンクしてワークフローを形成します。 Runbook を実行すると、リンクされた方法に従って各アクティビティが順番に呼び出されます。 各アクティビティは特定の職務を実行し、Orchestrator データ バスから入力データを収集し、その出力を同じデータ バスに発行できます。 各アクティビティには、Runbook で実行される前に実行されたアクティビティから発行済みデータを描画する機能があり、出力データを発行すると、次のアクティビティがそれにアクセスできます。
アクティビティの範囲は単純なものから複雑なものまでです。 コマンド ライン アクティビティ ウィザードを使用して、テキストを出力プロパティにエコーするアクティビティを作成できます。 また、仮想マシンのデプロイなどの複雑なマルチステップ アクションを実行する 1 つのアクティビティを作成することもできます。 各アクティビティの実行内容は、ユーザーが定義する必要があります。 ただし、目的は、さまざまな種類の状況で簡単に再利用できる単一の機能セットをカプセル化するアクティビティを定義することです。 重要なのは柔軟性です。 個別のシナリオを解決するために 20 個の異なるアクティビティを作成するのではなく、それぞれが特定の処理を行い、20 種類の方法でそれらのアクティビティを使用できる 10 個の異なるアクティビティのセットを作成することをお勧めします。 ベスト プラクティスの詳細については、このドキュメントの後半で説明します。
新しいアクティビティ アセンブリを作成する
新しいコマンド ライン アクティビティ アセンブリを作成する
新しいコマンド ライン アクティビティ アセンブリを作成するには、次の手順に従います。
Microsoft System Center 2012 > Orchestrator > Integration Toolkit > Orchestrator コマンド ライン アクティビティ ウィザード> [すべてのプログラム>開始] を選択します
[次へ] を選択します。
Assembly の詳細 ページで、文字で始まり、その後に 0 個以上の英数字が続く Name の値を入力します。 この名前は、アセンブリとアクティビティの C# 名前空間識別子として使用されます。
Assembly ファイルで、このウィザードによって作成されるアセンブリ ファイルのパスとファイル名を入力します。 このファイルが既に存在する場合は、ファイルを上書きするように求められます。
Assembly 情報を選択します。 ここでは、ファイル プロパティを使用して Windows エクスプローラーに表示されるアセンブリ ファイルのプロパティとなる情報を入力できます。 プロパティの値は、次の表で定義されています。 この情報は省略可能であり、アセンブリのビルドには必要ありません。
プロパティ Description タイトル アセンブリのタイトルを指定します。このタイトルは、Windows エクスプローラーのプロパティの File description プロパティとして表示されます。 説明 Windows エクスプローラーのプロパティに表示されないアセンブリの説明 (省略可能) を指定します Product アセンブリの製品名を指定します。この名前は、Windows エクスプローラーのプロパティの Product name プロパティとして表示されます。 会社 Windows エクスプローラーのプロパティに表示されないアセンブリの会社名を指定します。 著作権 アセンブリの著作権に関する通知を指定します。これは、Windows エクスプローラーのプロパティで Copyright として表示されます。 商標 アセンブリの商標を指定します。これは、Windows エクスプローラーのプロパティで Legal 商標 として表示されます。 バージョン アセンブリのバージョンとファイルのバージョンを指定します。 これらは、Windows エクスプローラーのプロパティに File version および Product version として表示されます。
バージョン番号には、次の 4 つの部分があります。
<メジャー バージョン>.<マイナー バージョン>.<ビルド番号>.<リビジョン>アセンブリ情報の入力が完了したら、 OK を選択します。
[次へ] を選択します。 Commands ページが表示されます。
アセンブリにコマンドを追加する で説明されている手順に従って、1 つ以上のコマンドを追加します。
アクティビティの定義が完了したら、 OKを選択します。 ダイアログが閉じ、新しいアクティビティが Commands ページの一覧に追加されます。 戻ってコマンドを編集する必要がある場合は、一覧からコマンドを選択し、[編集] を選択します。 コマンドを削除する必要がある場合は、一覧からコマンドを選択し、 Remove を選択します。
コマンドの追加と変更が完了したら、 次へを選択します。 ウィザードの開始時に指定されたアセンブリ ファイルがコンパイルされ、プロセスが完了すると、最終的なウィザード ページが表示されます。
この新しいアセンブリから統合パックをすぐにビルドする場合は、 Build Integration Pack ボタンを選択します。これにより、統合パック ウィザードが起動し、アセンブリから情報が事前に読み込まれます。 次に、 新しい統合パックの作成 の指示に従って統合パックを作成します。
.NET 呼び出しアクティビティを使用してアセンブリをテストする場合、または今のところ IP ビルド プロセスをスキップする場合は、 Finish を選択します。
アセンブリにコマンドを追加する
アセンブリにコマンドを追加する
アセンブリにコマンドを追加するには、次の手順に従います。
Commands ページでは、アセンブリに追加される 1 つ以上のコマンド (アクティビティ) を定義できます。 新しいコマンドを追加するには、 Add を選択します。
[コマンドの追加/編集]ダイアログボックスが表示され、General、Arguments、Published Data の 3 つのタブが含まれます。 コマンドに対して名前を入力します。 これは、アクティビティの Runbook デザイナーに表示される名前になります。 必要に応じて、コマンドの Description を入力することもできます。
Mode プロパティ セレクターには、コマンドの実行、Windows PowerShell の実行、プログラムの実行、SSH コマンドの実行の 4 つのオプションがあります。 プログラム実行 モードを選択した場合、Program フィールドがアクティブになります。 省略記号ボタン (...) を選択し、実行するプログラムを参照します。
Note
[プログラムの実行] コマンドで選択したプログラムは、このアクティビティを含む Runbook が実行されている Runbook サーバーで呼び出されます。 そのため、このプログラムは、Runbook を実行する予定のすべての Runbook サーバーに存在する必要があります。
Arguments タブを選択します。
[ コマンド ライン フィールドに、アクティビティに必要なコマンド またはコマンド ライン パラメーターを入力します。 ユーザーが指定するパラメーターをコマンドで受け取る場合は、以下の Parameters リストにパラメーターを追加し、 Insert ボタンを使用してコマンド ラインに追加する必要があります。
重要
Mode に Run Windows PowerShell を指定し統合パックに含まれている PowerShell スクリプトを参照する場合は、ローカル ディレクトリを参照するために、スクリプトの名前の前にドットとスラッシュの文字を付ける必要があります。 たとえば、MyScript.ps1 という名前のスクリプトには .\MyScript.ps1 が指定されます。 これは、スクリプト ファイルが統合パックの既定のディレクトリにコピーされるためです。 Windows PowerShell でローカル ディレクトリからスクリプトを実行する場合は、この表記を指定する必要があります。
コマンド ラインのパラメーターを指定するには、 Add を選択します。 パラメーターの追加/編集ダイアログが表示されます。
[名前] フィールドに、追加するパラメーターの名前を入力します。 これは、アクティビティの [プロパティ] リストに表示されるパラメーターの表示名です。
[使用法モード] ドロップダウン リストから、パラメーターに使用するモードを選択します。 使用モードには、次の 2 つの選択肢があります。
使用モード 説明 コマンド引数 コマンド ライン内でパラメーターとしてこの引数を使用する場合に選択します ( Insert ボタンを使用します)。 たとえば、次のようにコマンド ラインに "Folder" という名前のコマンド引数パラメーターを配置できます。
Dir $(folder)Note:コマンド ライン引数にスペース (フォルダー名など) が含まれている場合は、コマンドを正しく機能させるために、それらを引用符で囲む必要があります。 例:Dir "$(folder)"環境変数 コマンド ラインを実行する前に設定される環境変数としてこの引数を使用する場合に選択します。 これは、コマンド ライン パラメーターとして、または実行されるスクリプト内の環境変数として使用できます。
たとえば、次のようにコマンド ラインに "Folder" という名前の環境変数パラメーターを配置できます。
Dir %Folder%Important:環境変数名は、ユーザー環境またはシステム環境に既に存在します。コマンドは失敗し、次のようなエラー メッセージが表示されます。Item は既に追加されています。ディクショナリ内のキー: 'folder' 追加中のキー: 'folder'。 ローカル コンピューターまたはリモート コンピューターに存在する環境変数を確認するには、 [スタート] > [実行]を選択し、「MSINFO32.EXE」と入力します。 次に、 Software Environment > 環境変数を選択します。 別のコンピューターを選択するには、<CTRL + R> キーを押し、[ネットワーク上のコンピューターリモート] を選択コンピューター名を入力して、[OK] を選択。 Display スタイルドロップダウン リストから、パラメーターの表示に使用するスタイルを選択します。 表示スタイルは、ユーザーが入力を表示するときに入力を操作する方法を決定します。 次の選択肢について説明します。
表示スタイル 説明 テキスト ユーザーには、値を入力するための自由形式のテキスト ボックスが表示されます 暗号化されたテキスト ユーザーにマスクされたテキスト ボックスが表示されます。 このフィールドのデータはデータベース内で暗号化され、ログには表示されません True/False ユーザーは、ポップアップ ダイアログから True または False を選択できます 選択範囲を含むテキスト ユーザーは、指定した Options のグループから選択できます。 日付/時刻 ユーザーは、日付/時刻ピッカー コントロールを使用して値を選択できます ファイル ユーザーは、ファイル ブラウザー コントロールを使用して値を選択できます フォルダー ユーザーは、フォルダー ブラウザー コントロールを使用して値を選択できます コンピューター ユーザーは、コンピューター ブラウザー コントロールを使用して値を選択できます パラメーターに必要な場合、または既定値を指定する場合は、 Default 値 フィールドに入力します。
[選択テキスト] を選択した場合Optionsフィールドが有効になります。 ユーザーが選択できるオプション値を追加するには、 Options フィールドの横にある省略記号ボタンを選択して入力します。 各オプションは、個別の行に一覧表示されます。 オプションの追加が完了したら、 OK を選択します。
パラメーター定義が完了したら、 OKを選択します。
コマンド パラメーターとして定義されている場合は、コマンド ラインの目的のカーソル位置にカーソルを置き、Insert ボタンを選択してパラメーター名を選択することで、コマンド ラインにパラメーターを追加できるようになりました。 Environment 変数として定義されている場合コマンド ラインで必要な場合は、変数を (%variable% の形式で) 手動で入力する必要があります。
Run Program または Run Command Line モードを選択した場合、作業ディレクトリ パラメーターを含むのチェック ボックスが有効になります。
[パブリッシュされたデータ] タブを選択します。このタブの設定では、他のアクティビティが情報を使用できるように、Orchestrator データ バスに出力データを発行できます。
新しいパブリッシュされたデータ プロパティを追加するには、 Add を選択します。
実行コマンド、Run Program、または Run SSH Command オプションを Mode ドロップダウン リストの [追加/編集コマンド] ダイアログの [General] タブで選択した場合、[発行済みデータの追加/編集] ダイアログに次の項目 が表示されます。
項目 説明 Name 作成するパブリッシュ済みデータ項目の表示名 ソース 発行済みデータ項目のソース。 コマンド ラインから Standard Output Stream または Standard Error Stream から選択できます。 モード 発行されたデータを選択するために使用するモード。
Match Pattern を使用して、特定のパターンがソース内で見つかったかどうかを判断します。 これにより、 True または False が返されます。
Extract Group を使用して、指定したパターンに一致するデータの各項目を取得します。パターン モード設定に適用される正規表現 説明 Runbook Designer でパブリッシュされたデータ プロパティの横に表示される説明テキスト。 (省略可能) 追加/編集コマンド ダイアログの General タブの Mode ドロップダウン リストから Run Windows PowerShell オプションを選択した場合、[発行済みデータの追加/編集] ダイアログに次の項目 が表示されます。
項目 説明 Name 作成するパブリッシュ済みデータ項目の表示名 プロパティ 発行済みデータ項目に保存される Windows PowerShell プロパティの名前。 このプロパティは、スクリプト中に PowerShell パイプラインへのオブジェクト出力に含まれている必要があり、オブジェクトである必要はありません (文字列に変換できる必要があります)。 説明 Runbook Designer でパブリッシュされたデータ プロパティの横に表示される説明テキスト。 (省略可能) [ OK を選択して、発行済みデータ項目の追加を完了します。 追加する発行済みデータ項目ごとに、手順 16 から 18 を繰り返します。
OKを選択してコマンドの追加/編集ダイアログを閉じ、[コマンド] ダイアログに戻ります。
アクティビティ アセンブリをテストする
アセンブリを作成したら、(.NET 用 Integration Toolkit IP に含まれる) .NET 呼び出しアクティビティを使用してアセンブリをテストし、カスタム統合パックに変換する前に期待どおりに動作することを確認できます。
アセンブリをテストする
アセンブリをテストするには、次の手順に従います。
Runbook デザイナーを開きます。
新しい Runbook を作成します。
Activities ペインで、Integration Toolkit カテゴリを選択して展開し、Invoke .NET アクティビティを新しい Runbook にドラッグします。
[.NET オブジェクトの呼び出し] をダブルクリックして、 Properties ダイアログを表示します。
Assembly フィールドで、コマンド ライン アクティビティ ウィザードを使用して (または SDK を使用したカスタム開発を使用して) 作成したアセンブリ ファイルを、フィールドの右側にある省略記号ボタン (...) を選択して参照します。 ファイルを選択し、 開くを選択します。
Class フィールドの右側にある省略記号ボタンを選択して、アセンブリ内の個々のコマンドの一覧を表示します。 コマンド クラスを選択し、 OK を選択します。 このクラスのパラメーターは、ダイアログの Properties タブに表示されます。
Setup フィールドは、Orchestrator SDK と OrchestratorData 属性を使用するカスタム開発クラスでのみ使用されます。 SDK の詳細については、「 System Center Orchestrator Integration Toolkit SDK」を参照してください。
[プロパティ] タブを選択します。
必要に応じて、各プロパティの情報を指定します。
[ Finish を選択して設定を保存し、Runbook に戻ります。
Runbook デザイナー ツール バーの [Runbook Tester を選択します。 Runbook テスターが起動します。
ツール バー [ブレークポイントに実行] を選択します。 Runbook が開始され、アクティビティが実行されます。 アクティビティの結果は、 実行ログ ペインに表示されます。
[実行ログ] ウィンドウのアクティビティ名の下にある Show Details を選択すると、入力プロパティやパブリッシュされたデータなどの詳細な結果が表示されます。
QIK CLI アクティビティの移行
Opalis 6.3 QIK CLI ウィザードを使用して作成されたアセンブリがある場合は、Orchestrator 統合パックで使用するか、.NET 呼び出しアクティビティを使用して Runbook で直接使用する前に、Orchestrator と互換性のあるアセンブリを変換する必要があります。 変換プロセスは単純で、アセンブリごとに数秒しかかかりません。
重要
Microsoft .NET Framework 3.5 Service Pack 1 がインストールされていない場合、Orchestrator Integration Toolkit のインストールは失敗しませんが、コマンド ライン アクティビティ ウィザードが存在しない場合、異なる操作は失敗します。 CLI を使用する前に、Microsoft .NET Framework 3.5 Service Pack 1 がインストールされていることを確認します。
Opalis QIK CLI アセンブリを変換する
Opalis QIK CLI アセンブリを変換するには、次の手順に従います。
Microsoft System Center 2012 > Orchestrator > コマンド ライン アクティビティ ウィザード> [すべてのプログラム>開始] を選択して、Orchestrator コマンド ライン アクティビティ ウィザードを起動します
ウィザードが読み込まれたら、最初のページの Load existing assembly ボタンを選択します。
既存のアセンブリ ファイルを選択し、 Open を選択します。 アセンブリの名前とファイルの場所が表示されます。
変更が新しいファイルに保存されるように、ファイル パスを変更します。 必要に応じて、アセンブリの名前を変更することもできます。
アセンブリ情報の詳細をさらに変更する必要がある場合は、 Assembly 情報 ボタンを選択し、それらの変更を行います。 完了したら OK を選択して[アセンブリの詳細]ページに戻ります。
[次へを選択して、[コマンド] ページに移動します。 アセンブリで以前に定義されたコマンドの一覧が表示されます。 必要に応じてコマンドを確認し、 Next を選択して、 Building Assembly ページに進みます。
新しいアセンブリがビルドされ、前に定義したパスとファイル名を使用して保存されます。
Runbook で新しい Orchestrator 互換アセンブリを Invoke .NET アクティビティと共に使用できるようになりました。または、このアセンブリから Build Integration Pack ボタンを選択して統合パックをビルドできます。 現時点で IP を作成しない場合は、 Close を選択してウィザードを終了します。
Orchestrator のリソース
System Center 2012 Orchestrator で提供されるこのオンライン リファレンスに加えて、Runbook の構築、Integration Toolkit の使用、ベスト プラクティスに関する追加情報を提供できるリソースがいくつかあります。
フィードバック
以下は間もなく提供いたします。2024 年を通じて、コンテンツのフィードバック メカニズムとして GitHub の issue を段階的に廃止し、新しいフィードバック システムに置き換えます。 詳細については、「https://aka.ms/ContentUserFeedback」を参照してください。
フィードバックの送信と表示