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