パラメータ

最終公開日 : Oct 02, 2026
このセクションでは、構成を作成するためにStyleBookで必要となるすべてのパラメータを定義できます。StyleBookが受け取る入力を記述します。このセクションはオプションですが、ほとんどのStyleBookで必要となる場合があります。パラメータセクションは、NetScalerインスタンスで構成を作成するためにStyleBookを使用するユーザー向けのフィールドを定義するものと考えることができます。
StyleBookをNetScaler® ADMにインポートして構成を作成すると、GUIはStyleBookのこのセクションを使用してフォームを表示します。このフォームは、定義されたパラメータ値の入力を受け取ります。
次のセクションでは、このセクションの各パラメータに指定する必要がある属性について説明します。

「名前」

定義するパラメータの名前。英数字の名前を指定できます。
名前はアルファベットで始まる必要があり、さらにアルファベット、数字、ハイフン(-)、またはアンダースコア(_)を含めることができます。
StyleBookを作成する際、この「name」属性を使用して、表記 $parameters.\<name> を使用して他のセクションでパラメータを参照できます。
必須ですか?はい

「ラベル」

ADM GUIでこのパラメータの名前として表示される文字列。
必須ですか?いいえ

「説明」

パラメータの用途を説明するヘルプ文字列。ユーザーがこのパラメータのヘルプアイコンをクリックすると、ADM GUIにこのテキストが表示されます。
必須ですか?いいえ

'型'

これらのパラメータが取りうる値の型。パラメータは、以下のいずれかの 組み込み型にすることができます。
  • string: 文字の配列。長さが指定されていない場合、文字列値は任意の数の文字を取ることができます。ただし、min-length属性とmax-length属性を使用することで、文字列型の長さを制限できます。
  • number: 整数。min-value属性とmax-value属性を使用することで、この型が取りうる最小値と最大値を指定できます。
  • boolean: trueまたはfalseのいずれかになります。YAMLはすべてのリテラルをブール値と見なします(例: YesまたはNo)。
  • ipaddress: 有効なIPv4またはIPv6アドレスを表す文字列。
  • ipnetwork: 2つの部分から構成されます。最初の部分はIPアドレスで、2番目の部分はネットマスクです。
    IPネットワーク
    ネットマスクは、ネットマスク長 (netmask-len) またはネットマスクIPアドレス (netmask_ip) で構成されます。ネットマスク長は、IPv6アドレスの場合、0~32および0~128の間の整数です。これは、ネットワーク内のIPアドレス数を決定するために使用されます。
    NetScaler ADM GUIから構成パックを作成または更新する際、以下のいずれかのアクションを実行できます。
    • ネットマスク長を有効にし、IPアドレスとネットマスク長を入力します。
    • ネットマスク長を無効にし、IPアドレスとネットマスクIPアドレスを入力します。
    APIでは、ネットマスク長とネットマスクIPアドレスは、次の例に示すように単一の値として利用できます。
    例:
    Content-Type: application/json
    Accept: application/json
    {
    “configpack”:
    {
          “stylebook”: {
          “namespace”: “com.example.stylebook”,
          “version”:“1.0”,
          “name”: “ipnetwork-example”,
          ..
          },
          “parameters”: {
             “name: “test-app”,
              “virtual-ip”: “212.100.30.0/255.255.255.0”,
          },
          “targets”:
          [
          ]
    }
    }
  • tcp-port: TCPまたはUDPポートを表す0から65535までの数値。
  • password: 不透明な/秘密の文字列値を表します。ADM GUIがこのパラメーターの値を表示するときは、アスタリスク (*****) で表示されます。
  • certfile: 証明書ファイルを表します。この値を使用すると、ADM GUIを使用してStyleBook構成を作成するときに、ローカルシステムからファイルを直接アップロードできます。アップロードされた証明書ファイルは、ADMのディレクトリ /var/mps/tenants/\<tenant_path>/ns_ssl_certs に保存されます。
    証明書ファイルは、ADMによって管理される証明書のリストに追加されます。
  • keyfile: 証明書キーファイルを表します。この値を使用すると、ADM GUIを使用してStyleBook構成を作成するときに、ローカルシステムからファイルを直接アップロードできます。アップロードされた証明書ファイルは、ADMのディレクトリ /var/mps/tenants/\<tenant_path>/ns_ssl_keys に保存されます。
    証明書キーファイルは、ADMによって管理される証明書キーのリストに追加されます。
  • file: ファイルを表します。
  • object: このタイプは、関連する複数のパラメーターを親要素の下にグループ化する場合に使用します。親パラメーターのタイプを「object」として指定します。「object」タイプのパラメーターには、含まれるパラメーターを記述するためのネストされた「parameters」セクションを含めることができます。
  • another StyleBook: このタイプのパラメーターを使用する場合、このパラメーターは、そのタイプを示すStyleBookで定義されたパラメーターの形式で値を持つことを想定しています。
パラメーターには、タイプのリストである type を含めることもできます。そのためには、タイプの最後に [] を追加します。たとえば、type 属性が string[] の場合、このパラメーターは文字列のリストを入力として受け取ります。このStyleBookから構成を作成するときに、このパラメーターに1つ、2つ、または複数の文字列を指定できます。
必須ですか?はい

'ネットワーク'

type: ipaddress の場合、ADM IPAMネットワークからIPアドレスを自動割り当てするために network 属性を指定できます。
StyleBook構成を作成すると、ADMは network 属性からIPアドレスを自動割り当てします。
例:
name: virtual-ip
label: "Load Balancer IP Address"
type: ipaddress
network: "network-1"
required: true
この例では、virtual-ip フィールドは network-1 からIPアドレスを自動割り当てします。構成が削除されると、IPアドレスはネットワークに解放されます。

「動的割り当て」

dynamic-allocation 属性は type:ipaddress のパラメータ定義に追加されます。この属性を使用して、ADM IPAM ネットワークを動的にリストします。この属性は、入力として true または false のいずれかを取ることができます。type: ipaddress の場合、ADM にある ADM IPAM ネットワークを動的にリストするには、dynamic-allocation: true 属性を指定します。構成パック作成フォームでは、次のことができます。
  1. リストから必要なIPAMネットワークを選択します。
  2. 選択したIPAMネットワークから割り当てるIPアドレスを指定します。
    IPアドレスが指定されていない場合、ADMは選択したIPAMネットワークからIPアドレスを自動割り当てします。
例:
-
  name: virtual-ip
  label: "Load Balancer IP Address"
  type: ipaddress
  dynamic-allocation: true
  required: true
この例では、virtual-ip フィールドに ADM にある ADM IPAM ネットワークがリストされます。リストからネットワークを選択して、そのネットワークから IP アドレスを自動割り当てします。構成が削除されると、IP アドレスはネットワークに解放されます。

「キー」

このパラメータがStyleBookのキーパラメータであるかどうかを示すために、trueまたはfalseを指定します。
StyleBookでは、「キー」パラメータとして定義できるパラメータは1つだけです。
同じStyleBookから異なる構成を作成する場合(同じまたは 異なるADCインスタンス上)、各構成にはこの パラメータに対して異なる/一意の値が設定されます。
デフォルト値はfalseです。
必須ですか?いいえ

「必須」

パラメータが必須かオプションかを示すために、trueまたはfalseを指定します。trueに 設定されている場合、そのパラメータは必須であり、構成を作成する際にユーザーは このパラメータの値を指定する必要があります。
ADM GUIは、このパラメータに有効な値を指定するようユーザーに強制します。
デフォルト値はfalseです。
必須ですか? いいえ

'許可される値'

タイプが「string」に設定されている場合、この属性を使用して、パラメータの有効な値のリストを定義します。
ADM GUIから構成を作成する際、ユーザーはこのリストからパラメータ値を選択するよう求められます。
注
リスト値をラジオオプションとして表示したい場合は、layout属性を設定します。
例 1:
-
      name: ipaddress
      type: string
      allowed-values:
            -  SOURCEIP
            -  DEST IP
            -  NONE
例 2:
-
      name: TCP Port
      type: tcp-port
      allowed-values:
            -  80
            -  81
            -  8080
例 3:
tcp-portsのリスト。リストの各要素は、allowed-valuesで指定された値のみを持つことができます。
-
      name: tcpports
      type: tcp-port[]
      allowed-values:
            -  80
            -  81
            -  8080
            -  8081
必須ですか? いいえ

'デフォルト'

この属性を使用して、オプションのパラメータにデフォルト値を割り当てます。ユーザーが値を指定せずに構成を作成すると、デフォルト値が使用されます。
以下の条件が満たされた場合、パラメータは値を取りません。
  • パラメータにデフォルト値がありません。
  • ユーザーがパラメータに値を提供しません。
例 1:
-
      name: timeout
      type: number
      default: 20
例 2:
パラメータのデフォルト値を一覧表示するには:
-
      name: protocols
      type: string[]
      default:
            -  TCP
            -  UDP
            -  IP
例 3:
-
      name: timeout
      type: number
      default: 20
例 4:
-
      name: tcpport
      type: tcp-port
      default: 20
必須ですか? いいえ

'パターン'

この属性を使用して、パラメータの型が「string」の場合に、この パラメータの有効な値のパターン (正規表現) を定義します。
例:
-
      name: appname
      type: string
      pattern: "[a-z]+"
必須ですか? いいえ

'最小値'

この属性を使用して、number または tcp-port 型のパラメータの最小値を定義します。
例:
-
      name: audio-port
      type: tcp-port
      min-value: 5000
数値のmin-valueは負の値にすることができます。ただし、tcp-portのmin-valueは正の値でなければなりません。
必須ですか? いいえ

'最大値'

この属性を使用して、numberまたは tcp-port型のパラメータの最大値を定義します。
定義されている場合、最大値が最小値より大きいことを確認してください。
例:
-
      name: audio-port
      type: tcp-port
      min-value: 5000
      max-value: 15000
必須ですか? いいえ

'最小長'

この属性を使用して、「string」型のパラメータに受け入れられる値の 最小長を定義します。
値として定義されている文字の最小長が0以上であることを確認してください。
例:
-
      name: appname
      type: string
      min-length: 3
必須ですか? いいえ

'最大長'

この属性を使用して、「string」型のパラメータに受け入れられる値の 最大長を定義します。
値の最大長が、min-length で定義されている文字の長さ以上であることを確認します。
例:
-
      name: appname
      type: string
      max-length: 64
必須? いいえ

'最小項目数'

この属性を使用して、リストであるパラメータの最小項目数を定義します。
最小項目数がゼロ以上であることを確認します。
例:
-
      name: server-ips
      type: ipaddress[]
      min-items: 2
必須? いいえ

'最大項目数'

この属性を使用して、リストである パラメータの最大項目数を定義します。
定義されている場合、最大項目数が最小項目数より大きいことを確認します。
例:
-
      name: server-ips
      type: ipaddress[]
      min-items: 2
      max-items: 250
必須? いいえ

'グラフィカルユーザーインターフェース'

この属性を使用して、ADM GUI でパラメータのレイアウトをカスタマイズします。
必須ですか? いいえ

'列'

この属性は、gui 属性のサブ属性です。この属性を使用して、ADM GUI に type: object[] パラメータを表示する列の数を定義します。
必須ですか? いいえ

'更新可能'

この属性は、gui 属性のサブ属性です。この属性を使用して、構成の作成後にパラメータを更新できるかどうかを指定します。この属性は、文字列、ブール値、数値などの単純なパラメータタイプにのみ設定します。
値が false に設定されている場合、構成を更新するときに、パラメータフィールドはグレー表示されます。
必須ですか? いいえ

'collapse_pane'

この属性は、gui 属性のサブ属性です。この属性を使用して、このオブジェクトパラメータのレイアウトを定義するペインを折りたたみ可能にするかどうかを指定します。
値が true に設定されている場合、ユーザーは、この親パラメータの下にある子パラメータを展開または折りたたむことができます。
例:
gui:

 collapse_pane: true

 columns: 2
完全なパラメータセクションの例:

parameters:

   -

      name: name

      label: Name

      description: Name of the application

      type: string

      required: true

   -

      name: ip

      label: IP Address

      description: The virtual IP address used for this application

      type: ipaddress

      required: true

   -

      name: svc-servers

      label: Servers

      type: object\[\]

      required: true

      parameters:

        -

              name: svc-ip

              label: Server IP

              description: The IP address of the server

              type: ipaddress

              required: true

        -

              name: svc-port

              label: Server Port

              description: The TCP port of the server

              type: tcp-port

              default: 80

        -

              name: lb-alg

              label: LoadBalancing Algorithm

              type: string

              allowed-values:

                 - ROUNDROBIN

                 - LEASTCONNECTION

              default: ROUNDROBIN

        -

              name: enable-healthcheck

              label: Enable HealthCheck?

              type: boolean

              default: true
以下は、リストのすべての属性と、以前のセクションで説明した値を定義する例です。

        -
              name: features-list

              type: string[]

              min-length: 1

              max-length: 3

              min-items: 1

              max-items: 3

              pattern: "\[A-Z\]+"

              allowed-values:

                - SP

                - LB

                - CS

              default:

                - LB

'レイアウト'

この属性は、gui属性のサブ属性です。この属性を使用して、リスト値をラジオボタンとして表示します。StyleBook定義のパラメータセクションで、layout属性をradioに設定します。これは、allowed-values属性を持つパラメータに適用されます。設定パックを作成すると、ADM GUIはallowed-valuesリストの値をラジオボタンとして表示します。
例:
-
    gui:
        layout: radio
    allowed-values:
        - One
        - Two
        - Three
「One」、「Two」、「Three」の値がADM GUIにラジオボタンとして表示されます。

'依存パラメータ'

この属性は、gui属性のサブ属性です。これは、別のパラメータで指定された値に基づいて、StyleBook設定フォームでのパラメータの表示または初期値を動的に制御します。
フォーム上のパラメータの動作を制御するソースパラメータにこの属性を指定します。他のパラメータを制御する複数の条件を含めることができます。たとえば、ソースパラメータprotocolは、protocolパラメータの値がSSLの場合にのみ表示される従属パラメータcertificateを持つことができます。
各条件には、次の属性を含めることができます。
  • target-parameter: この条件が適用されるターゲットパラメータを指定します。
  • matching-values: アクションをトリガーするソースパラメータの値のリストを指定します。
  • action: ターゲットパラメータに対して次のいずれかのアクションを指定します。
    • read-only: パラメータは読み取り専用になります。
    • show: パラメータが非表示の場合、フォームに表示されます。
    • hide: パラメータはフォームから削除されます。
    • set-value: パラメータ値は、value属性で指定された値に設定されます。
  • value: アクションがset-valueの場合のターゲットパラメータの値。
ユーザー入力がソースパラメータで指定された値と一致すると、ターゲットパラメータの外観または値が指定されたアクションに従って変更されます。
例:
 -
    name: lb-virtual-port
    label: "Load Balanced App Virtual Port"
    description: "TCP port representing the Load Balanced application"
    type: tcp-port
    gui:
      updatable: false
      dependent-parameters:
            -
              matching-values:
                - 80
              target-parameter: $parameters.lb-service-type
              action: set-value
              allowed-values:
              - HTTP
              - TCP
              - UDP

    default: 80
この例では、依存パラメータはlb-virtual-portパラメータ(ソースパラメータ)の下に指定されています。
ソースパラメータの値が80に設定されると、lb-service-typeパラメータがset-valueアクションをトリガーします。その結果、ユーザーは次のいずれかのオプションを選択できます。
  • HTTP
  • TCP
  • UDP