Cisco UCS Director リリース 6.6 オーケストレーション ガイド

偏向のない言語

この製品のマニュアルセットは、偏向のない言語を使用するように配慮されています。このマニュアルセットでの偏向のない言語とは、年齢、障害、性別、人種的アイデンティティ、民族的アイデンティティ、性的指向、社会経済的地位、およびインターセクショナリティに基づく差別を意味しない言語として定義されています。製品ソフトウェアのユーザーインターフェイスにハードコードされている言語、RFP のドキュメントに基づいて使用されている言語、または参照されているサードパーティ製品で使用されている言語によりドキュメントに例外が存在する場合があります。シスコのインクルーシブランゲージに対する取り組みの詳細は、こちらをご覧ください。

翻訳について

このドキュメントは、米国シスコ発行ドキュメントの参考和訳です。リンク情報につきましては、日本語版掲載時点で、英語版にアップデートがあり、リンク先のページが移動/変更されている場合がありますことをご了承ください。あくまでも参考和訳となりますので、正式な内容については米国サイトのドキュメントを参照ください。

マニュアルのコンテンツ
このマニュアル内で検索
ご利用いただける言語
Download Options

Book Title

Cisco UCS Director リリース 6.6 オーケストレーション ガイド

Chapter Title

ワークフロー コンポーネントのカスタマイズ

検索結果

Updated:
2018年9月6日

章のタイトル： ワークフロー コンポーネントのカスタマイズ

ワークフロー コンポーネントのカスタマイズ

この章の内容は、次のとおりです。

複合タスクの作成

複合タスクは、1 つのタスクとして機能するワークフローです。複合タスクは他のタスクと同様にアトミックです。複合タスクのコンポーネント タスクは隠されます。

複合タスクを作成するには、ワークフローを作成または編集する際に、ワークフローを複合タスクとして保存します。たとえば、同じ一連のタスクを異なる複数のワークフローに構成していることがわかったとします。

その場合、単純なワークフローを定義して複合タスクとして保存した後、その複合タスクを組み込む別のワークフローを定義することができます。このパターンを使用して、ますます複雑なワークフローを定義していくことができます。

既存のワークフローを複合タスクとして保存するには、次の手順を実行します。


（注）  

新しい複合タスクを最初から作成する場合は、ワークフローの作成 を参照してください。

手順

ステップ 1

[オーケストレーション（Orchestration）] を選択します。

ステップ 2

[オーケストレーション（Orchestration）] ページで [ワークフロー（Workflows）] をクリックします。

ステップ 3

複合タスクとして保存するワークフローを選択します。
ステップ 4

[Edit] をクリックします。

ステップ 5

[複合タスクとして保存（Save as Compound Task）] をオンにします。

ステップ 6

ワークフローのすべてのタスク出力を複合タスクの出力として使用できるようにするには、[タスク出力を複合タスク出力としてパブリッシュ（Publish Task outputs as Compound Task outputs）] をオンにします。

ステップ 7

[Next] をクリックします。

ステップ 8

[ユーザ入力の追加（Add User Inputs）] 画面で、[次へ（Next）] をクリックします。

ステップ 9

[ユーザ出力の追加（Add User Outputs）] 画面で、[送信（Submit）] をクリックします。

[ワークフロー デザイナ（Workflow Designer）] を開くと、新しい複合タスクが [複合タスク（Compound Task）] フォルダ内で使用可能になります。

例：複合タスクの作成

この例では、リスト内の要素に対してワークフローのタスクを繰り返す方法を説明します。

始める前に

例：ワークフローの作成の説明に従ってサンプル ワークフローを作成します。

手順

ステップ 1

[ポリシー（Policies）] > [オーケストレーション（Orchestration）] に移動します。

ステップ 2

[ワークフロー（Workflows）] タブをクリックします。

ステップ 3

例：ワークフローの作成で作成した PowerCycleVM ワークフローを探して選択します。

ステップ 4

[Edit] をクリックします。

ステップ 5

[ワークフローの詳細の編集（Edit Workflow Details）] ウィンドウで、[複合タスクとして保存（Save as Compound Task）] チェックボックスをオンにします。

（注）   

出力があるタスクはないので、[タスク出力を複合タスク出力としてパブリッシュ（Publish Task outputs as Compound Task outputs）] チェックボックスは無視します。このワークフローは Cisco UCS Director のシステム起動には関係しないため、[システム初期化中に常に実行します（Always execute during System initialization）] チェックボックスも無視します。

ステップ 6

[ワークフローの出力の編集（Edit Workflow Output）] ページが表示されるまでクリックします。

ステップ 7

[Submit] をクリックします。`

次のタスク

カスタム タスクを他のワークフローに含めます。たとえば、リモートでホストされる VM に変更を加えるワークフローの [完了（失敗）（Completed (Failed)）] タスクの前に、このタスクを配置できます。変更が失敗した場合は、VM を再起動します。

カスタム承認の作成

ワークフローの実行時に、承認者が入力値を入力できる、カスタム承認タスクを作成できます。

手順

ステップ 1

[オーケストレーション（Orchestration）] を選択します。

ステップ 2

[オーケストレーション（Orchestration）] ページで [カスタム承認タスク（Custom Approval Tasks）] をクリックします。

ステップ 3

[Add] をクリックします。

ステップ 4

[入力の追加（Add Inputs）] 画面で、次のフィールドに値を入力します。

名前 説明

承認タスク名（Approval Task Name）

[ワークフローデザイナ（Workflow Designer）] に表示される承認タスクの名前。

承認タスクの説明（Approval Task Description）

承認タスクの説明（任意）。
ステップ 5

[入力フィールドの追加（Add Input Field）] をクリックします。

ステップ 6

新しい入力フィールドの [ユーザ入力（User Input）] 見出しで、次のフィールドに値を入力します。

名前 説明

入力ラベル（Input Label）

入力のラベル（タスクの承認者が指定）。

入力の説明（Input Description）

入力の説明。

入力タイプ

入力のデータ タイプを含むドロップダウンリスト。

オプション入力（Optional Input）

[オプション入力（Optional Input）] をオンにする場合は、管理者が入力のデフォルト値を指定する必要があります。この場合、承認者が値を入力する必要はありません。

ステップ 7

必要な入力の数だけ、上記の 2 つのステップを繰り返します。
ステップ 8

[Submit] をクリックします。`

次のタスク

このカスタム タスクをワークフローに含めることができます。

カスタム入力の作成

ワークフローの入力として使用するカスタム入力タイプを作成できます。カスタム入力タイプは、既存の入力タイプに基づきます。有効な入力値を絞り込むためのフィルタ基準または選択内容によって、カスタム入力タイプが定義されます。

手順

ステップ 1

[オーケストレーション（Orchestration）] を選択します。

ステップ 2

[オーケストレーション（Orchestration）] ページで [カスタム ワークフローの入力値（Custom Workflow Inputs）] をクリックします。

ステップ 3

[Add] をクリックします。

ステップ 4

[カスタム ワークフロー入力の追加] ページで、次のフィールドに値を入力します。

名前 説明

カスタム入力タイプ名（Custom Input Type Name）

入力の名前。

入力タイプ

このボタンをクリックすると、既存の入力タイプのリストが表示されます。このリストから、カスタム入力タイプの基準とする入力タイプを選択します。

フィルタ

選択した入力タイプによって、次のフィルタ タイプの 1 つ以上が使用可能になります。

  • [入力フィルタ（Input Filter）]：テキスト フィールド。フィルタ文字列を入力します。

  • [入力リスト（Input List）]：値のリスト（LOV）。この入力に有効なインスタンスとする既存の値を選択します。

  • [入力 LOV（Input LOV）]：この入力に使用可能な名前と値のペアのリストを定義します。

    （注）   

    [ラベル（Label）] フィールドと [値（Value）] フィールドの記述は矛盾しないようにする必要があります。

  • [入力範囲（Input Range）]：テキスト フィールド。有効な文字の値の範囲を入力します。

  • [検証済みの入力（Validated Input）]：テーブルからバリデータ タイプを選択します。

ステップ 5

[（＋）追加（(+) Add）] をクリックします。

ステップ 6

[Submit] をクリックします。`

新しい入力タイプが [カスタム ワークフロー タイプ（Custom Workflow Types）] ページに追加されます。ワークフローやタスクの入力を定義するときに、新しい入力タイプを選択できるようになります。

オーケストレーション グローバル変数

グローバル変数は、Cisco UCS Director Orchestrator 内で複数のタイプの可変システム情報を 2 箇所で公開するために使用できる変数です。

  • ワークフロー内のタスク入力変数。ここでは、以下の情報にアクセスできます。

    • ワークフローの入力とタスクの出力

    • サービス リクエスト ID

    • ID、名前、IP アドレス、および電源状態などの VM 情報

  • VM 名。ここでは、以下の情報にアクセスできます。

    • グループ ID やユーザ ID などのユーザ情報

    • カタログおよびシステム プロファイルなどの設定情報

    • クラウドの名前と場所などの導入情報

独自のグローバル変数を定義し、ワークフローで使用できるようにすることもできます。

オーケストレーション変数

グローバル変数は、ワークフローの実行中にワークフローのタスクからアクセスできる変数です。Cisco UCS Director のワークフローを作成する際に、そのワークフローのタスク、ユーザ、または管理者の入力値のいずれかで変数を使用できます。入力フィールドには、テキストと変数を任意の組み合わせで含めることができます。ワークフローの実行中は、Cisco UCS Director Orchestrator が各タスクを実行する前に、変数の値を置き換えてタスクに挿入します。

次の 4 つのカテゴリからの変数を使用できます。

入力と出力のシステム変数
入力と出力の変数は、単に実行時のワークフローの入力と出力です。これらの入力と出力をキャプチャし、ワークフロー内のタスクへの入力を作成するために使用できます。
サービス リクエストのグローバル変数
サービス リクエストのグローバル変数は、現在実行中のワークフローを含むサービス リクエストに関する情報を提供します。
仮想マシンのグローバル変数
仮想マシン（VM）のコンテキストで実行されるワークフローの場合、VM グローバル変数には VM に関する情報が含まれています。
ユーザ定義によるグローバル変数
任意のサービス リクエストの任意のタスクに使用可能なユーザ定義のグローバル変数を作成できます。システム指定の変数とは異なり、ユーザ定義のグローバル変数は変更および削除できます。

次の各項では、さまざまなタイプの変数について説明します。

入力と出力のシステム変数

ワークフロー レベルの入力または前のタスクの出力は、後続のタスクで変数として使用できます。たとえば、ディスク サイズの入力と最大スナップショット数というラベルが付けられた 2 つの入力があるワークフローが存在し、このワークフローに task1 と task2 という ID が設定された 2 つのタスクがあるとします（task1 が最初に実行されるように配置されています）。task1 または task2 への自由形式の入力値では、以下の 2 つの変数を使用できます。

  • ${Enter Disk Size}

  • ${Max Snapshots}


（注）  

システム変数は、ドル記号（$）とそれに続く、波括弧（{}）で囲まれた変数名で構成されます。ワークフロー レベルの入力は、変数定義でユーザ入力に関連付けられたラベルを含めることで、変数として使用できます。

また、2 番目のタスク task2 では、task1 の出力を使用できます。task1 に OUTPUT_VOLUME_NAME と OUTPUT_VOLUME_SIZE という 2 つの出力変数がある場合、task2 では以下の記法を使用して、これらの出力変数の値を入力に取り込むことができます。

  • ${task1.OUTPUT_VOLUME_NAME}

  • ${task1.OUTPUT_VOLUME_SIZE}


（注）  

タスク出力の変数名は、タスク名の後にピリオド、その後にタスク出力変数名が続く、${taskName.outputName} の形式になります。

入力変数を使用して、Admin の入力をフィルタリングするには

admin 入力、admin 入力リスト、または admin 入力フィルタに設定を行うには、入力変数を使用することができます。たとえば、次の 2 つのカスタム タスク入力を持つワークフローがあるとします。

  • Host Pool。これは型が gen_text_input（汎用テキスト）で、Pool 1、Pool 2 などといったいくつかのプール ラベルを含む、入力値リスト（LOV）を伴う。

  • Host。これは型が gen_text_input で、Host 1 Pool 1、 Host 2 Pool 1 などといういくつかのホスト/ラベルの組み合わせを含む入力 LOV と、Host Pool 入力を CONTAINS ${Host Pool} という形式で参照している admin フィルタを伴う。

ワークフローを実行し、Host Pool LOV からプールを選択すると、Host 入力 LOV は、選択したプールを含むエントリのみを示します。たとえば、Pool 2 を Host Pool LOV から選択すると、Host LOV は Host 1 Pool 2、Host 2 Pool 2 などに制限されます。別のプールを選択すると、入力画面がもう一度更新され、Host LOV には新しいプールからのホストだけが表示されます。


（注）  

この例では、Host Pool LOV からエントリを選択すると、ワークフローの入力画面は更新され、Host LOV を含む、ページのすべてのコントロールが更新されます。この更新の動作が、単純なテキスト入力の制御によってトリガーされることはありません。そのため、ワークフローの入力をフィルタ リングしても、同じ画面の自由形式、非リストの入力に影響を及ぼすことはありません。

たとえば、Host Pool が、（LOV を伴うカスタム入力型ではなく） gen_text_input 型である場合、Host ドロップダウンにに更新が表示されることは、Host Poolフィールドに何を入力したとしてもあり得ません。

サービス リクエストのグローバル変数

ワークフローの入力およびタスクの出力に加え、サービス リクエストを表す以下の変数も使用できます。

  • ${SR_ID}：現在のサービス リクエストの ID

  • ${PARENT_SR_ID}：現在のサービス リクエストの親となっているサービス リクエストの ID（現在のサービス リクエストに親がある場合にのみ使用可能）

VM システム変数の詳細なリストについては、VM マクロおよび VM アノテーションの一覧 を参照してください。

仮想マシンのシステム変数

VM のコンテキストで実行されるワークフローでは、より多くの VM システム変数を使用できます。VM システム変数は、VM 以外のコンテキスト ワークフローでは使用できません。

VM システム変数の詳細なリストについては、VM マクロおよび VM アノテーションの一覧 を参照してください。

ユーザ定義によるグローバル変数

グローバル変数を作成、複製、変更、および削除できます。グローバル変数は、Cisco UCS Director 内の任意のワークフローの任意のタスクで使用できます。

ユーザ定義のグローバル変数は、一般的なテキスト入力タイプでのみ使用できます。


（注）  

既存のワークフローでタスクによって使用されるユーザ定義のグローバル変数は削除できます。このようなワークフローが実行されると、グローバル変数が見つからないタスクは変数を解決せずに実行され、予期しない結果が生じることがあります。管理者は、削除されたグローバル変数がサービス リクエストに含まれないようにする必要があります。

グローバル変数の作成

グローバル変数を作成するには、次の手順を実行します。

手順
ステップ 1

[オーケストレーション（Orchestration）] を選択します。

ステップ 2

[オーケストレーション（Orchestration）] ページで [グローバル変数（Global Variables）] をクリックします。

ステップ 3

[（＋）追加（(+) Add）] をクリックします。

ステップ 4

[グローバル変数の追加（Add Global Variable）] 画面で、次のフィールドに入力します。

  1. [名前（Name）] フィールドに、グローバル変数の一意の名前を入力します。

  2. [説明（Description）] フィールドに、グローバル変数の説明を入力します（任意）。

  3. [値（Value）] フィールドに、グローバル変数の値を入力します。これは、グローバル変数がタスクで使用される場合に挿入されるテキストです。

ユーザ定義のグローバル変数には次の制限があります。

  • グローバル変数の [名前（Name）] には、次の 19 文字のいずれかを含めることができない可能性があります："%&'*+,./:;<=>?^|}{

    グローバル変数の [説明（Description）] または [値（Value）] には、任意の文字を含めることができます。

  • グローバル変数の [名前（Name）]、[説明（Description）]、または [値（Value）] にはスペースを含めることができますが、スペースで開始または終了することはできません。 スペース文字は、名前、値、または説明の最初と最後から削除されます。

  • グローバル変数の [値（Value）] には、静的テキストのみを含めることができます。他のグローバル変数（ネストされたグローバル変数）を含むグローバル変数値は、実行時に評価されません。

  • グローバル変数は、一般的なテキスト タイプ入力でのみ使用できます。
ステップ 5

[Submit] をクリックします。`

グローバル変数の複製

グローバル変数を複製するには、次の手順を実行します。

始める前に

グローバル変数を作成していること。グローバル変数の作成を参照してください。

手順
ステップ 1

[オーケストレーション（Orchestration）] を選択します。

ステップ 2

[オーケストレーション（Orchestration）] ページで [グローバル変数（Global Variables）] をクリックします。

ステップ 3

複製するグローバル変数を選択します。システム定義またはユーザ定義のグローバル変数を選択できます。
ステップ 4

[Clone] をクリックします。

ステップ 5

[グローバル変数の複製（Clone Global Variable）] 画面で、次のフィールドに入力します。

  1. [名前（Name）] フィールドに、グローバル変数の一意の名前を入力します。グローバル変数の名前を変更する必要があります。

  2. [説明（Description）] フィールドに、グローバル変数の説明を入力します（任意）。

  3. [値（Value）] フィールドに、グローバル変数の値を入力します。これは、グローバル変数がタスクで使用される場合に挿入されるテキストです。

ユーザ定義のグローバル変数には次の制限があります。

  • グローバル変数の [名前（Name）] には、次の 19 文字のいずれかを含めることができない可能性があります："%&'*+,./:;<=>?^|}{

    グローバル変数の [説明（Description）] または [値（Value）] には、任意の文字を含めることができます。

  • グローバル変数の [名前（Name）]、[説明（Description）]、または [値（Value）] にはスペースを含めることができますが、スペースで開始または終了することはできません。 スペース文字は、名前、値、または説明の最初と最後から削除されます。

  • グローバル変数の [値（Value）] には、静的テキストのみを含めることができます。他のグローバル変数を含むグローバル変数値は、実行時に評価されません。

  • グローバル変数は、一般的なテキスト タイプ入力でのみ使用できます。
ステップ 6

[Submit] をクリックします。`

グローバル変数の編集

グローバル変数を変更するには、次の手順を実行します。

始める前に

グローバル変数を作成していること。グローバル変数の作成を参照してください。

手順
ステップ 1

[オーケストレーション（Orchestration）] を選択します。

ステップ 2

[オーケストレーション（Orchestration）] ページで [グローバル変数（Global Variables）] をクリックします。

ステップ 3

[ユーザ定義（User Defined）] フォルダから、編集するグローバル変数を選択します。

ステップ 4

[Edit] をクリックします。

ステップ 5

[グローバル変数の編集（Edit Global Variable）] 画面で、次のフィールドに入力します。

  1. 既存のグローバル変数の [名前（Name）] フィールドは変更できません。

  2. [説明（Description）] フィールドで、グローバル変数の説明を変更または追加します（任意）。

  3. [値（Value）] フィールドで、グローバル変数の値を変更します。これは、グローバル変数がタスクで使用される場合に挿入されるテキストです。

ユーザ定義のグローバル変数には次の制限があります。

  • グローバル変数の [名前（Name）] には、次の 19 文字のいずれかを含めることができない可能性があります："%&'*+,./:;<=>?^|}{

    グローバル変数の [説明（Description）] または [値（Value）] には、任意の文字を含めることができます。

  • グローバル変数の [名前（Name）]、[説明（Description）]、または [値（Value）] にはスペースを含めることができますが、スペースで開始または終了することはできません。 スペース文字は、名前、値、または説明の最初と最後から削除されます。

  • グローバル変数の [値（Value）] には、静的テキストのみを含めることができます。他のグローバル変数を含むグローバル変数値は、実行時に評価されません。

  • グローバル変数は、一般的なテキスト タイプ入力でのみ使用できます。
ステップ 6

[Submit] をクリックします。`

グローバル変数の削除

グローバル変数を削除するには、次の手順を実行します。

手順
ステップ 1

[オーケストレーション（Orchestration）] を選択します。

ステップ 2

[オーケストレーション（Orchestration）] ページで [グローバル変数（Global Variables）] をクリックします。

ステップ 3

[ユーザ定義（User Defined）] フォルダから、削除するグローバル変数を選択します。

ステップ 4

[Delete] をクリックします。

ステップ 5

[グローバル変数の削除（Delete Global Variable）] 画面で、[削除（Delete）] をクリックします。

VM アノテーション

VM アノテーションは、VM に関する情報を表します。VM アノテーションを VMware システム ポリシーに定義する場合は、変数をそのポリシーに追加します。VMware vCenter では、これらの変数の出力が VM の Annotations フィールドに表示されます。

VM アノテーションの詳細なリストについては、VM マクロおよび VM アノテーションの一覧を参照してください。

VM マクロおよび VM アノテーションの一覧

VM のマクロに使用する構文は、VM アノテーションに使用する構文とは異なる場合があります。さらに、VM のマクロには VM アノテーションより多くの変数を使用できます。次の表に、VM マクロと VM アノテーションの正しい構文を記載します。セルに「該当なし」が含まれている場合、変数はそのコンテキストでは使用できません。

システム ポリシーの [VM 名のテンプレート（VM Name Template）] および [VM ホスト名のテンプレート（VM Host Name Template）] フィールドで使用できる変数については、『Cisco UCS Director Administration Guide』を参照してください。


（注）  

このテーブルには、CloupiaScript マクロの完全なリストは含まれていません。CloupiaScript マクロの使用については、『Cisco UCS Director CloupiaScript Cookbook』を参照してください。

変数

オーケストレーション ワークフローの VM マクロ

システム ポリシーの VM アノテーション

VM name

${VM_NAME}

${VMNAME}

VM IP アドレス

${VM_IPADDRESS}

該当なし

VM 状態（on または off）

${VM_STATE}

該当なし

VM 状態の詳細（power-on または power-off）

${VM_STATE_DETAILS}

該当なし

VM をホスティングしている ESX サーバまたはホスト ノード

${VM_PARENT}

該当なし

VM のプロビジョニングに使用されるクラウド

${VM_CLOUD}

${CLOUD_NAME}

クラウドのタイプ

該当なし

${CLOUD_TYPE}

VM のホスト名

${VM_HOSTNAME}

該当なし

短い VM ホスト名

${VM_HOSTNAME_SHORT}

該当なし

VM のホスト名とドメイン

${VM_HOSTNAME_DOMAIN}

該当なし

VM が属するグループの名前

${VM_GROUP_NAME}

${GROUP_NAME}

グループの完全な名前

該当なし

${FULL_GROUP_NAME}

グループの ID

${VM_GROUP_ID}

該当なし

親グループの名前（該当する場合）

該当なし

${GROUP_PARENT}

VM のプロビジョニングに使用されるカタログの ID

${VM_CATALOG_ID}

該当なし

VM のプロビジョニングに使用されるカタログの名前

該当なし

${CATALOG_NAME}

VM ID

${VM_ID}

該当なし

VM のサービス リクエスト ID

${M_SR_ID}

${SR_ID}

VM を要求したユーザからのコメント

${VM_COMMENTS}

${COMMENTS}

仮想データセンターの名前

${VM_VDC_NAME}

該当なし

仮想データセンターの ID

${VM_VDC_ID}

該当なし

VM のタイプ

${VM_TYPE}

該当なし

VM にスケジュールされている終了時

${VM_SCHED_TERM}

該当なし

アカウントで指定されている場所

該当なし

${LOCATION}

VM のコスト センター

該当なし

${COST_CENTER}

VM の固有 ID に変換される現在時刻（ミリ秒）

該当なし

${UNIQUE_ID}

VM を要求したユーザ

該当なし

${USER}

VM を要求したユーザのフル ネーム

該当なし

${FULL_USER_NAME}

カタログでのアプリケーション コード

該当なし

${APPCODE}

アプリケーションのカテゴリに関連付けられたシステム ポリシーの名前

該当なし

${PROFILE_NAME}

要求を開始したユーザの名前。

該当なし

${INITIATING_USER}

要求を開始したユーザの単純名。

該当なし

${INITIATING_USER_SIMPLE_NAME}

要求を送信したユーザの電子メール アドレス

該当なし

${SUBMITTER_EMAIL}

要求を送信したユーザの ID

該当なし

${SUBMITTER_USERID}

要求を送信したユーザの名

該当なし

${SUBMITTER_FIRSTNAME}

要求を送信したユーザの姓

該当なし

${SUBMITTER_LASTNAME}

要求を送信したユーザの権限

該当なし

${SUBMITTER_ROLE}

要求を送信したユーザが所属するグループの名前

該当なし

${SUBMITTER_GROUPNAME}

要求を送信したユーザが属するグループの ID

該当なし

${SUBMITTER_GROUPID}

このドキュメントは役に立ちましたか?

Feedbackフィードバック

シスコに問い合わせ