NetScalerインスタンスをデータソースとして使用する

最終公開日 : Oct 02, 2026
管理対象のNetScalerインスタンスをデータソースとして使用できます。managed-adcは、NetScaler Consoleでデータソースとしてすぐに使用できる組み込みのデータソースタイプです。NetScaler Consoleの各管理対象NetScalerインスタンスは、デフォルトでデータソースです。設定パックの作成時に、NetScaler Consoleによって管理されている既存のNetScalerからデータが必要な場合は、StyleBookでこれらのデータソースの使用を開始できます。
StyleBookの定義で、datum組み込みタイプパラメータを指定します。StyleBookでデータソースタイプを使用できます。StyleBookユーザーは、そのソースからデータを取得するために使用できるデータソースを選択できます。

コレクションなしで組み込みデータソースを使用する

parameters:
  - name: selected-adc
    label: Select an existing NetScaler
    type: datum
    required: true
    data-source:
      type: managed-adc
この例では、datumパラメータを使用して、NetScaler Consoleによって管理されている任意のNetScalerインスタンスを選択します。managed-adc組み込みデータソースを使用すると、NetScaler Consoleによって管理されている任意のNetScalerインスタンスからデータを取得できます。
StyleBookでは、選択したNetScalerインスタンスから任意の構成にアクセスできます。そして、同じNetScalerまたは別のNetScalerインスタンスで構成を作成または更新する際に、その構成を使用できます。これは、選択したターゲットNetScalerインスタンスによって異なります。
データソースからコレクションにアクセスする:
選択したNetScalerインスタンスでコレクションにアクセスするには、次の式を使用します。
$parameters.selected-adc.collections.<collection-name>
例:
$parameters.selected-adc.collections.lbvserver
この式は、選択したNetScalerインスタンス上のlbvserverエンティティのリストを返します。たとえば、このリストを反復処理して、特定の条件を満たす特定のlbvserverを選択できます。

コレクションなしのStyleBookの例

name: add-vservers-from-managed-adc-instances
namespace: com.citrix.adc.stylebooks
version: "1.0"
schema-version: "1.0"

import-stylebooks:
  -
    namespace: netscaler.nitro.config
    prefix: ns
    version: "10.5"

parameters:
    -
      name: selected-adc
      label: Select a NetScaler instance
      type: datum
      required: true
      data-source:
        type: "managed-adc"

components:
  -
    name: sslvserver-comp
    type: ns::sslvserver
    repeat: $parameters.selected-adc.collections.lbvserver
    repeat-item: lbvs
    repeat-condition: $lbvs.attributes.servicetype == "SSL"
    properties:
      name: $lbvs.attributes.name
      ssl2: DISABLED
      ssl3: DISABLED
      tls1: DISABLED
      tls11: ENABLED
      tls12: ENABLED
構成パックGUIには、NetScaler Consoleによって管理されているNetScalerインスタンスが表示され、StyleBookユーザーは構成パックの作成または更新時に任意のNetScalerを選択できます。
組み込みのNetScalerデータソース(コレクションなし)(/en-us/netscaler-application-delivery-management-software/media/managed-adc-without-collection.png)
このStyleBookは、選択したNetScalerを使用し、すべてのlbvserverエンティティを反復処理します。SSL仮想サーバーを選択し、各仮想サーバーで許可されるSSLプロトコルバージョンを設定します。
次の式を使用すると、NetScalerインスタンス内のlbvserverエンティティのリストを反復処理できます。
repeat: $parameters.selected-adc.collections.lbvserver
  • collections: NetScalerインスタンス上のすべてのエンティティタイプを指します。例えば、csvserver、lbmonitor、servicegroupなど。
  • lbvserver: NetScalerインスタンス内のロードバランシング仮想サーバーエンティティのリストを指します。

コレクションで組み込みデータソースを使用する

parameters:
  - name: selected-lbvserver
    label: Select an existing lbvserver
    type: datum
    required: true
    data-source:
      type: managed-adc
      collection: lbvserver
この例では、datumパラメーターを使用して、ユーザーがNetScalerインスタンスと特定のlbvserverの両方をmanaged-adcデータソースタイプから選択できるようにします。
parametersセクションでコレクションタイプを定義すると、StyleBookユーザーはNetScalerインスタンスとそのインスタンス上のコレクションから特定のエンティティを選択できます。
コレクション付き組み込みインスタンスデータソース
選択したアイテムの属性にアクセスする:
StyleBookユーザーが仮想サーバーを選択すると、StyleBook内の次の式で、選択したアイテムの任意の属性にアクセスできます。
$parameters.selected-lbvserver.attributes.<attribute-name>
この例では、選択されたdatumはlbvserverです。したがって、name、servicetype、ipv46など、NetScalerエンティティlbvserverの任意の属性にアクセスできます。
例:
$parameters.selected-lbvserver.attributes.ipv46
この式は、選択したロードバランシング仮想サーバーのIPを取得します。NetScalerエンティティ(コレクション)とその属性の詳細については、NetScaler NITRO APIリファレンスを参照してください。
コレクションから複数のアイテムを選択する:
次のパラメーターセクションでは、StyleBookユーザーがコレクションの複数のアイテムを選択できます。
parameters:
  - name: selected-lbvservers
    label: Select existing lbvservers
    type: datum[]
    required: true
    data-source:
      type: managed-adc
      collection: lbvserver
この例では、datumパラメーターはデータソース配列を定義するために使用されます。ユーザーは、単一のNetScaler®インスタンスから、または複数のNetScalerインスタンスにわたって、1つ以上のlbvserverを選択できます。
以下のコードスニペットは、選択したアイテムとその属性にアクセスする方法を示しています。
components:
  - name: sslvserver-comp
    type: ns::sslvserver
    repeat:
      repeat-list: $parameters.selected-lbvservers
      repeat-item: vserverObj
    properties:
      name: $vserverObj.attributes.name
      ssl2: DISABLED
      ssl3: DISABLED
      tls1: DISABLED
      tls11: ENABLED
      tls12: ENABLED
選択したアイテムの参照によるコレクションへのアクセス:
StyleBookユーザーが管理対象のNetScalerインスタンスで特定のエンティティを選択できるようにするだけでなく、選択したNetScalerインスタンス上の同じまたは異なるコレクションから任意のエンティティにアクセスすることもできます。そのNetScalerインスタンス上の別のコレクションにアクセスするには、componentsセクションで次の式を使用します。
$parameters.selected-lbvserver.datasource.collections.<collection-name>
例:
$parameters.selected-lbvserver.datasource.collections.csvserver
この式は、選択したNetScalerインスタンスからコンテンツスイッチング仮想サーバーのリストを返します。
また、次の式は、lbvserversとservicegroups間のすべてのバインディングのリストを返します。
$parameters.selected-lbvserver.datasource.collections.lbvserver_servicegroup_binding

コレクションを含むStyleBookの例

以下は、管理対象のNetScalerインスタンスをデータソースとして使用する方法を示すStyleBookの例です。
name: bind-lb-to-servicegroup-using-ADC-as-datasource
namespace: com.citrix.adc.stylebooks
version: "1.1"
display-name: "HTTP/SSL LoadBalancing StyleBook with Service Binding"
description: "This stylebook defines a typical Load Balanced Application configuration where we allow the user to select an existing lbvserver on the NetScaler using datum type parameter. Then a servicegroup for the selected lb is created if it does not exist on the NetScaler. Finally, the selected lbvserver is bound to the service "
schema-version: "1.0"
import-stylebooks:
  -
    namespace: netscaler.nitro.config
    prefix: ns
    version: "10.5"

parameters:
  -
    name: selected-vserver
    label: "Select an Existing VServer"
    description: "Load Balancing Application Vservers to be bound to service on the ADC"
    type: datum
    required: true
    data-source:
      type: managed-adc
      collection: lbvserver

components:
  -
    name: servicegroup-discovery-comp
    type: object
    repeat: $parameters.selected-vserver.datasource.collections.servicegroup
    repeat-item: svcgrp
    repeat-condition: $svcgrp.attributes.servicegroupname ==  $parameters.selected-vserver.attributes.name + "-svcgrp"
    properties:
      servicegroupname: $svcgrp.attributes.servicegroupname
  -
    name: servicegroup-creation-if-not-exists-comp
    type: ns::servicegroup
    condition: not exists($components.servicegroup-discovery-comp)
    properties:
      servicegroupname: $parameters.selected-vserver.attributes.name + "-svcgrp"
      servicetype: $parameters.selected-vserver.attributes.servicetype
    components:
      -
        name: lbvserver-servicegroup-binding
        type: ns::lbvserver_servicegroup_binding
        properties:
          name: $parameters.selected-vserver.attributes.name
          servicegroupname: $parent.properties.servicegroupname
このStyleBookでは、componentsセクションは、選択したロードバランシング仮想サーバー名とsvcgrpを連結したものに一致するサービスグループ名をチェックします。
選択したロードバランシング仮想サーバーの名前がlbv1の場合、このStyleBookはlbv1-svcgrpという名前のサービスグループをチェックします。見つからない場合、サービスグループlbv1-svcgrpを作成し、lbv1仮想サーバーにバインドします。
次の式は、NetScalerインスタンス内のサービスグループのリストを取得します。
repeat: $parameters.selected-vserver.datasource.collections.servicegroup
この式では:
  • datasource: NetScaler Consoleによって管理されている選択したNetScalerインスタンスを指します。
  • collections: NetScalerインスタンス内のすべてのエンティティを指します。
  • servicegroup: NetScalerインスタンス内のサービスグループを指します。
コレクションデータのフィルタリング:
以下のパラメータセクションでは、StyleBook定義で組み込みデータソースコレクションにフィルターを指定する方法を説明します。これにより、StyleBookユーザーはフィルターされたコレクションから特定の項目を選択できます。
parameters:
  - name: selected-lbvserver
    label: Select an existing lbvserver
    type: datum
    required: true
    data-source:
      type: managed-adc
      collection: lbvserver
      collection-filters:
        protocol: SSL
この例では、datumパラメータを使用して、ユーザーがNetScalerインスタンスと、managed-adcデータソースタイプからSSLプロトコルを持つ特定のlbvserverの両方を選択できるようにします。
StyleBookユーザーが仮想サーバーを選択した後、選択された項目の任意の属性は、前のセクションで説明したのと同じ方法でアクセスできます。