リソースブロックの入力パラメーターの構成

  • リリースバージョン: Yokohama
  • 更新日 2025年01月30日
  • 所要時間：4分

    • 入力パラメーター、ステップ、および出力属性を指定することにより、リソースブロックの各インターフェースに対して操作を構成できます。入力パラメーターには、リソースが含まれているデータセンターやリソースグループなど、仮想リソースを識別して管理するためにシステムが必要とする値が保持されます。

    始める前に

    必要なロール：sn_cmp.cloud_service_designer

    このタスクについて

    インターフェイスを追加すると、システムは、クラウド API (CAPI) からリソースブロックにデフォルトの操作を自動的に関連付けます。操作ごとにデフォルトの入力パラメーターも提供します。

    手順

    1. リソースブロックを開き、[操作] タブをクリックします。

      リソースブロックの [操作] タブ

      [入力パラメーター] サブタブがデフォルトで表示されます。

    2. [インターフェイス] の選択リストからインターフェイスを選択します。

      この選択リストのインターフェイスは、リソースブロックの作成時にすでに構成されている [一般情報] タブの [リソースゲストインターフェイス] リストから取得されます。

      リソースブロックインターフェイスの選択

    3. 入力パラメーターを変更する操作を選択します。
      新しい操作を作成することもできます。
      1. [操作を追加] アイコンをクリックします。

        操作の追加

      2. フォームに入力します (テーブルを参照)。
        フィールド 説明
        名前 内容を端的に表す名前を入力します。
        操作タイプ 選択リストから操作のタイプを選択します。
        アクセスタイプ

        ユーザーが所有するスタックを管理するときに、カタログ注文フォームからリソースブロック操作を使用できるようにするには、[公開] を選択します。実際の操作は、カタログ注文フォームのリストに表示されます。

        ユーザーの操作

        ユーザーがスタックを起動したときに操作が使用されないようにするには、[プライベート] を選択します。

        この設定は、カタログアイテムレベルで適用され、スタックレベル全体には適用されません。詳細計画を構成する際に、スタック全体のアクセスタイプを制御できます。

        たとえば、個別の VM のプロビジョニング解除操作をプライベートとしてマークする必要があっても、スタック全体に対してはマークを付けないようにします。これにより、ユーザーは一度にすべてをプロビジョニング解除でき、VM のみをプロビジョニング解除できなくなります。
      3. [送信] をクリックします。
    4. 選択した操作の実行に必要なアイテムを入力する方法を提供するように、入力パラメーターを構成します。

      たとえば、AWS リソースのプロビジョン操作を追加する場合、操作の実行には少なくとも CloudAccount パラメーターと Location パラメーターが必要です。何を渡すのかを確認するには、プロバイダー API が必要です。たとえば、AWS で S3 バケットのプロビジョン操作を追加する場合、バケットで許容される AWS 操作とバケットと、バケットの作成などの要求要素 (PUT バケット操作) を把握する必要があります。これらのリソースは通常、AWS および Azure のドキュメントで確認できます。

      1. [入力パラメータを追加] アイコンをクリックします。

        入力パラメータを追加

      2. クラウドプロバイダー API から取得したパラメーターの [名前] を追加します。
        この例では、AWS S3 バケットに CreateBucketConfiguration を追加できます。
      3. [データソース] 列で、設定する入力パラメーターのタイプを選択します。
        この値は、パラメーター値の送信元または場所を指定します。
        • テキスト：ユーザーが渡すテキスト値。
        • プール：プールに対して実行して、そこから値を取得するクエリ。プールの [データソース値] は ServiceNow::Pools::PoolName.Pool-Filter-Name の命名規則に従う必要があります。プールの詳細については、「クラウドプロビジョニング のプールとフィルター」を参照してください。
        • CSVList：[データソース値] に入力したコンマ区切り値リストからの値。
        • アレイ：値のアレイ。プログラムを使用してアレイを JavaScript で送信できます。フォーマットは ['abc','def'] です。
        • FormData：詳細計画で構成されたフォームから送信されたデータ。
        • ResourceScript：値を渡す式。式は、[マッピング] フィールドで次の命名規則に従う必要があります。

          $(Script:script-name.function[arg1=${value-to-pass},arg2=${value-to-pass}])

        • TLR：詳細計画でこのリソースブロック上にある最上位レベルのリソースコンテナーから継承された値。
      4. [保存] をクリックします。
      5. [マッピング] 列には自動生成されたマッピング値を表示できます。
        マッピングは、システム内の情報をプルする場所を指定します。式を入力する必要がある [ResourceScript] タイプのパラメーターを除き、マッピング値を変更する必要はありません。
      6. [デフォルト値] 列で、ユーザーが値を渡さなかった場合、または [データソース値] に何も入力しなかった場合にシステムで使用する値を指定します。
      7. [フォームの作成 (Create Form)] を選択すると、スタックアイテムのプロビジョニング時にユーザーに表示される注文フォームでこの属性を使用できるようになります。
        また、[必須] を選択して、ユーザーに値の入力を求めることもできます。
      8. [次に制限] 列で、制限付きアイコン ([次に制限]) をクリックし、リソースブロックを選択して特定のホストに渡す属性を制限します。

        この例では、VmFolderName 属性で表される VM フォルダーの名前を必要とする、vSphere 上の仮想サーバーに対するリソースブロックを構成しています。その他のデータセンターのタイプに VM フォルダーの名前は必要ありません。したがって、vSphere データセンターのリソースブロックに VmFolderName を制限できます。

        この図は、VMFolderName 属性が vSphere データセンターに制限される仕組みを示しています。VMFolderName

        vSphere データセンターへの制限