この製品のマニュアルセットは、偏向のない言語を使用するように配慮されています。このマニュアルセットでの偏向のない言語とは、年齢、障害、性別、人種的アイデンティティ、民族的アイデンティティ、性的指向、社会経済的地位、およびインターセクショナリティに基づく差別を意味しない言語として定義されています。製品ソフトウェアのユーザーインターフェイスにハードコードされている言語、RFP のドキュメントに基づいて使用されている言語、または参照されているサードパーティ製品で使用されている言語によりドキュメントに例外が存在する場合があります。シスコのインクルーシブランゲージに対する取り組みの詳細は、こちらをご覧ください。
このドキュメントは、米国シスコ発行ドキュメントの参考和訳です。リンク情報につきましては、日本語版掲載時点で、英語版にアップデートがあり、リンク先のページが移動/変更されている場合がありますことをご了承ください。あくまでも参考和訳となりますので、正式な内容については米国サイトのドキュメントを参照ください。
この章は、次の項で構成されています。
基本的に、スクリプト モジュールは、カスタム スクリプト、JAR ファイル、および入力コントロールを収容するコンテナです。スクリプト モジュールにこれらの要素を含めることにより、カスタム ワークフロー タスクに統合可能なライブラリ スクリプトを追加するなどといった、カスタマイズされたアクションを実行できます。スクリプト モジュールをエクスポートして、別のアプライアンスにインポートすることができます。インポートされたモジュールに含まれる登録済みスクリプトは、新しいアプライアンスで使用可能になります。
次の表に、スクリプト モジュールを使用して実行できるアクションの説明を記載します。
タスク |
参照先 |
---|---|
スクリプト モジュールの追加 |
|
ライブラリの追加 |
|
jar の追加 |
|
値のリスト(LOV)の追加 |
|
表形式のレポートの追加 |
|
コンテキスト マッピングの追加 |
|
スクリプト モジュールのエクスポート |
|
スクリプト モジュールのインポート |
新しいスクリプト モジュールを作成するには、次の手順を実行します。
タスク ライブラリを追加するには、次の手順に従います。
ライブラリを追加するには、その前に、スクリプト モジュールが必要です。参照先 スクリプト モジュールの追加
ステップ 1 | メニュー バーで、 を選択します。 | ||||||||
ステップ 2 | [スクリプト モジュール(Script Modules)] タブをクリックします。 | ||||||||
ステップ 3 | [スクリプト モジュール(Script Modules)] ペインで、ライブラリを追加するスクリプト モジュールをダブル クリックします。 | ||||||||
ステップ 4 | [ライブラリ(Library)] タブをクリックします。 | ||||||||
ステップ 5 | [追加(Add)] をクリックします。 | ||||||||
ステップ 6 | [ライブラリ情報(Library Information)] 画面で、次の情報を入力します。
| ||||||||
ステップ 7 | [送信(Submit)] をクリックします。 |
ライブラリには次の方法でアクセスできます。
loadLibrary("Module Name>/<Library Name>") という構文を使用して別のライブラリからライブラリを呼び出します。
ImportPackage(java.lang); function test1(){ logger.addInfo("test1"); loadLibrary("Test_Module/testlib1"); } test1();
カスタム ワークフロー タスクを作成するときに、上記の例と同じ構文を使用してライブラリを呼び出すことができます。カスタム タスクからライブラリを呼び出す方法を含め、カスタム タスクの使用方法については、『Cisco UCS Director Custom Task Getting Started Guide』を参照してください。
スクリプト モジュールには、.jar ファイルを登録できます。ファイルを登録すると、スクリプト モジュールを使用して、ライブラリまたはカスタム タスクから .jar の内容を呼び出せるようになります。
スクリプトに .jar ファイルを追加するには、次の手順を実行します。
ステップ 1 | メニュー バーで、 を選択します。 |
ステップ 2 | [スクリプト モジュール(Script Modules)] タブをクリックします。 |
ステップ 3 | [スクリプト モジュール(Script Modules)] ペインで、jar ファイルを追加するスクリプト モジュールをダブル クリックします。 |
ステップ 4 | [jar] タブをクリックします。 |
ステップ 5 | [追加(Add)] をクリックします。 |
ステップ 6 | [Jar の追加(Add Jar)] 画面で、[参照(Browse)] をクリックします。 |
ステップ 7 | ローカル フォルダから、アップグレードする .jar ファイルを選択します。 |
ステップ 8 | [送信(Submit)] をクリックします。 |
値のリスト(LOV)とは、Cisco UCS Director GUI から呼び出したり、タスクまたはワークフローの入力として呼び出したりできる、検索可能なリストのことです。たとえば、タスクまたはワークフローの入力のデータ タイプを選択する際に、LOV を呼び出して選択肢を表示することができます。
独自の値のセットを表示する LOV をタスクやワークフローの入力として作成し、作成した LOV をスクリプト モジュールに保存できます。
値のリスト(LOV)を作成するには、次の手順を実行します。
スクリプト モジュールを作成します。
ステップ 1 | メニュー バーで、 を選択します。 | ||||||||||
ステップ 2 | [スクリプトモジュール(Script Module)] タブをクリックします。 | ||||||||||
ステップ 3 | [スクリプトモジュール(Script Module)] ペインで、使用するスクリプト モジュールをダブルクリックします。 | ||||||||||
ステップ 4 | [LOV(LOVs)] タブをクリックします。 | ||||||||||
ステップ 5 | [追加(Add)] をクリックします。 | ||||||||||
ステップ 6 | [LOV 情報(LOV Information)] ダイアログボックスで、次の手順を実行します。
| ||||||||||
ステップ 7 | [スクリプト(Script)] テキスト ボックスで、次のようにして名前と値のペアをリストに追加します。 | ||||||||||
ステップ 8 | [送信(Submit)] をクリックします。 |
既存の値のリスト(LOV)を編集するには、次の手順を実行します。
ステップ 1 | メニュー バーで、 を選択します。 | ||||||||||||
ステップ 2 | [スクリプトモジュール(Script Module)] タブをクリックします。 | ||||||||||||
ステップ 3 | [スクリプトモジュール(Script Module)] ペインで、編集する LOV を含むスクリプト モジュールをダブルクリックします。 | ||||||||||||
ステップ 4 | [LOV(LOVs)] タブを選択します。 | ||||||||||||
ステップ 5 | 編集する LOV を選択します。 | ||||||||||||
ステップ 6 | [編集(Edit)] をクリックします。 | ||||||||||||
ステップ 7 | 変更が許可されている LOV フィールドを編集します。
| ||||||||||||
ステップ 8 | [送信(Submit)] をクリックします。 |
すべてのカスタム タスクとワークフローから値のリスト(LOV)への参照を削除します。
表形式のレポートとは、Cisco UCS Director GUI から呼び出したり、タスクまたはワークフローの入力として呼び出したりできる、カラム型リストのことです。たとえば、[Workflow] タブでワークフローを選択する際に、表形式のレポートを呼び出して選択肢を表示できます。
独自の定義済み値のセットをタスクまたはワークフローの入力として表示する表形式のレポートを作成できます。作成した表形式のレポートは、スクリプト モジュールに保存できます。
スクリプト モジュールを作成します。
ステップ 1 | メニュー バーで、 を選択します。 | ||||||||||||||
ステップ 2 | [スクリプトモジュール(Script Module)] タブをクリックします。 | ||||||||||||||
ステップ 3 | [スクリプトモジュール(Script Module)] ペインで、使用するスクリプト モジュールをダブルクリックします。 | ||||||||||||||
ステップ 4 | [表形式のレポート(Tabular Reports)] タブをクリックします。 | ||||||||||||||
ステップ 5 | 追加(+)ボタンをクリックします。 | ||||||||||||||
ステップ 6 | [表形式のレポート情報(Tabular Report Information)] ダイアログボックスで、次の手順を実行します。
| ||||||||||||||
ステップ 7 | [送信(Submit)] をクリックします。 | ||||||||||||||
ステップ 8 | 作成する列のすべてに対して、上記の 2 つのステップを繰り返します。 | ||||||||||||||
ステップ 9 | [スクリプトを表示(Show Script)] チェックボックス:[スクリプト(Script)] テキスト エリアを表示して編集できるようにするには、このチェックボックスをオンにします。
列を作成するときに、[スクリプト(Script)] テキスト エリアの列の作成スクリプトが自動的に生成されます。 レコードは 1 つの行からなり、その行には列ごとに 1 つの値が格納されます。レコードを作成するには、[スクリプト(Script)] テキスト エリアを編集します。
| ||||||||||||||
ステップ 10 | [送信(Submit)] をクリックします。 |
表形式レポートに 2 つの列のエントリを作成するとします。最初の列のエントリの列名は Name、列タイプは Text です。2 番目の列のエントリの列名は Department、列タイプは Long です。表形式レポートに列のエントリを作成すると、システムによって、それらの列を作成するスクリプト内に以下の関数呼び出しが生成されます。
function implementationForTabularReport(report) { var model = new TabularReportInternalModel(); model.addTextColumn("Name","Name"); model.addNumberColumn("Department","Department"); model.completedHeader(); //START OF YOUR IMPLEMENTATION. //END OF YOUR IMPLEMENTATION. model.updateReport(report); } function getSelectionColumnId(){ return "1"; } function getDisplayColumnId(){ return "0"; }
スクリプト中央に //START OF YOUR IMPLEMENTATION. で始まり //END OF YOUR IMPLEMENTATION で終わるセクションがあります。この 2 つの行の間にレコード エントリを作成します。 レコード エントリにより、値が列のエントリに割り当てられます。
以下の例では、テキスト値 "Smith" が列名 Name の列に割り当てられ、長整数型の数値 40 が列名 Department の列に割り当てられます。関数呼び出し model.completedRow(); は、このレコード エントリの終了を示します。
function implementationForTabularReport(report) { var model = new TabularReportInternalModel(); model.addTextColumn("Name","Name"); model.addLongNumberColumn("Department","Department"); model.completedHeader(); //START OF YOUR IMPLEMENTATION. model.addTextValue("Smith"); model.addLongNumberValue(40); model.completedRow(); //END OF YOUR IMPLEMENTATION. model.updateReport(report); } function getSelectionColumnId(){ return "1"; } function getDisplayColumnId(){ return "0"; }
ステップ 1 | メニュー バーで、 を選択します。 | ||
ステップ 2 | [スクリプトモジュール(Script Module)] タブをクリックします。 | ||
ステップ 3 | [スクリプト モジュール(Script Module)] ペインで、表形式のレポートを編集するスクリプト モジュールをダブルクリックします。 | ||
ステップ 4 | [表形式のレポート(Tabular Report)] タブを選択します。 | ||
ステップ 5 | 編集する表形式のレポートの名前を選択し、[編集(Edit)] をクリックします。 | ||
ステップ 6 | [編集(Edit)] ダイアログボックスで、変更するフィールドを編集します。
| ||
ステップ 7 | [送信(Submit)] をクリックします。 |
すべてのカスタム ワークフロー タスクから表形式のレポートへの参照を削除します。
コンテキスト ワークフロー マッピングは、ページ上のワークフローにマッピングされたアクション ラベルからなります。このアクション ラベルをクリックすると、ワークフローがトリガーされます。
(注) | 厳密には、コンテキスト マッピングはオーケストレーションに含まれません。これは、Cisco UCS Director ユーザ インターフェイスに対する変更です。コンテキスト マッピングがここに含まれているわけは、スクリプト モジュールの有用なアプリケーションであるためです。 |
コンテキスト マッピング モジュールを使用すると、コンテキスト ワークフロー マッピングを動的に追加することができます。この場合、ページのアクション ラベルを作成し、そのアクション ラベルにワークフローを割り当てることで、Cisco UCS Director UI をカスタマイズできます。
コンテキスト マッピングを作成するには、アクション ラベルを追加するページの名前を把握している必要があります。ページの名前およびその他のメタデータは、Cisco UCS Director で開発者メニュー を有効にすると、[情報(Information)] ダイアログに表示されます。
コンテキスト マッピングを作成する前に、次のセクションの説明に従って、メタデータを有効にします。
レポート メタデータにアクセスするには、開発者メニューを有効にします。
(注) | レポート メタデータでのレポートという言葉は、Cisco UCS Director ユーザ インターフェイス内のページを指します。 |
開発者メニューを有効にするには、次の手順を実行します。
ステップ 1 | Cisco IMC Supervisor で右上にあるログイン名をクリックします。 たとえば、admin としてログインしている場合、Cisco IMC Supervisor の右上に admin と表示されます。 | ||
ステップ 2 | [ユーザ情報(User Information)] ダイアログボックスで、[詳細設定(Advanced)] タブをクリックします。 | ||
ステップ 3 | [[開発者]メニューの有効化(このセッション)(Enable Developer Menu (for this session))] チェックボックスをオンにします。
現在のセッション中、[REST API ブラウザ(REST API Browser)] が [オーケストレーション(Orchestration)] メニューでアクティブになり、このセッションで開かれるレポート ビューで [レポート メタデータ(Report Metadata)] オプションが利用可能になります。
| ||
ステップ 4 | [ユーザ情報(User Information)] ダイアログボックスを選択します。 |
任意のレポートで [レポート メタデータ(Report Metadata)] アクションをクリックして、レポート名を含むレポート メタデータを表示します。
スクリプト モジュールを作成します。
アクション ラベルを使用するページを識別します。レポート メタデータを使用して、そのページの名前を見つけます。メタデータの有効化を参照してください。コンテキスト マッピングを作成する際は、そのページの名前を使用します。
ステップ 1 | メニュー バーで、 を選択します。 | ||||||||||||||||
ステップ 2 | [スクリプトモジュール(Script Module)] タブをクリックします。 | ||||||||||||||||
ステップ 3 | [スクリプトモジュール(Script Module)] ペインで、使用するスクリプト モジュールをダブルクリックします。 | ||||||||||||||||
ステップ 4 | [コンテキストマッピング(Context Mapping)] タブをクリックします。 | ||||||||||||||||
ステップ 5 | [追加(Add)] をクリックします。 | ||||||||||||||||
ステップ 6 | [コンテキストマッパーの追加(Add Context Mapper)] ダイアログボックスで、次の手順を実行します。
| ||||||||||||||||
ステップ 7 | [送信(Submit)] をクリックします。 [ステータス(Status)] 列に [成功(Success)] または [失敗(Fail)] と表示されます。 | ||||||||||||||||
ステップ 8 | 結果が [失敗(Fail)] の場合は、コンテキスト マッピングを編集し、正しいレポート名と表形式フィールドが入力されていることを確認してから、再度 [送信(Submit)] をクリックします。 | ||||||||||||||||
ステップ 9 | 結果が [成功(Success)] の場合は、メニュー バーで、 を選択します。 | ||||||||||||||||
ステップ 10 | [コンテキストワークフローマッピング(Context Workflow Mapping)] タブをクリックします。 作成したコンテキスト マッピングが [マッピング名(Mapping Name)] 列にリストされます。 | ||||||||||||||||
ステップ 11 | 作成したコンテキスト ワークフロー マッピングをクリックします。 | ||||||||||||||||
ステップ 12 | [編集(Edit)] をクリックします。 | ||||||||||||||||
ステップ 13 | [ワークフローマッピングの編集(Edit Workflow Mappings)] ダイアログボックスで、[ワークフローの追加(Add Workflow)] をクリックします。 | ||||||||||||||||
ステップ 14 | [ワークフロー 1(Workflow 1)] ダイアログボックスで、次の手順を実行します。
このコンテキスト ワークフロー マッピングに追加のワークフロー手順を追加するには、[ワークフローの追加(Add Workflow)] ボタンをクリックし、フィールドに値を入力します。 このコンテキスト ワークフロー マッピングからワークフローの手順を削除するには、削除するワークフローの下の [フィールドの削除(Delete Field)] をクリックします。 | ||||||||||||||||
ステップ 15 | ワークフロー マッピングが完成したら、[送信(Submit)] をクリックします。 マッピングされたレポートに、定義したアクション ラベルが表示されます。 |
コンテキスト マッピングを編集するには、次の手順を実行します。
ステップ 1 | メニュー バーで、 を選択します。 |
ステップ 2 | [スクリプトモジュール(Script Module)] タブをクリックします。 |
ステップ 3 | [スクリプト モジュール(Script Module)] ペインで、編集するコンテキスト マッピングが含まれているスクリプト モジュールをダブルクリックします。 |
ステップ 4 | [コンテキスト マッピング(Context Mapping)] タブを選択します。 |
ステップ 5 | 編集するコンテキスト マッピングの名前を選択し、[編集(Edit)] をクリックします。 |
ステップ 6 | [コンテキスト マッパーの編集(Edit Context Mapper)] 画面で、変更するフィールドを編集します。
[名前(Name)] フィールドは編集できません。 [表形式フィールド(Tabular Fields)] フィールドの値を選択します。この選択は必須です。前の値は維持されません。 |
ステップ 7 | [送信(Submit)] をクリックします。 |
コンテキスト マッピングを削除するには、次の手順を実行します。
すべてのワークフローとレポートからコンテキスト マッピングへの参照を削除します。
ステップ 1 | メニュー バーで、 を選択します。 |
ステップ 2 | [スクリプトモジュール(Script Module)] タブをクリックします。 |
ステップ 3 | [スクリプトモジュール(Script Module)] ペインで、削除するコンテキスト マッピングが含まれているスクリプト モジュールをダブルクリックします。 |
ステップ 4 | [コンテキストマッピング(Context Mapping)] タブを選択します。 |
ステップ 5 | 削除するコンテキスト マッピングの名前を選択します。 |
ステップ 6 | [削除(Delete)] をクリックします。 削除を確認するポップアップが表示されます。 |
ステップ 7 | [送信(Submit)] をクリックします。 |
ワークフロー、カスタム タスク、およびアクティビティをインポートおよびエクスポートするために使用する [インポート(Import)] および [エクスポート(Export)] アクションを使用して、スクリプト モジュールをインポート、エクスポートすることもできます。
スクリプト モジュールをインポートする場合は、ワークフロー、カスタム タスク、スクリプト モジュール、およびアクティビティのインポートを参照してください。
スクリプト モジュールをエクスポートする場合は、ワークフロー、カスタム タスク、スクリプト モジュール、およびアクティビティのエクスポートを参照してください。