ロードバランシング仮想サーバーを作成するためのStyleBook

最終公開日 : Sep 25, 2026
この例では、HTTPプロトコルタイプでポート80をリッスンするロードバランシング仮想サーバーを作成する基本的なStyleBookを設計します。仮想サーバー名、IPアドレス、およびロードバランシングメソッドのパラメーターは、ユーザー定義の値を受け入れます。つまり、これらはStyleBookのパラメーターです。

ヘッダー

StyleBookの最初の6行はヘッダーセクションで構成されます。この例では、ヘッダーセクションは次のように記述されています。
name: lb-vserver
namespace: com.example.stylebook
version: "1.0"
display-name: Load Balancing Virtual Server (HTTP)
description: "This stylebook defines a very simple load balancing HTTP virtual server configuration"
schema-version: "1.0"
ヘッダーセクションには、次の詳細が含まれます。
  • name: このStyleBookの名前。
  • description: このStyleBookが何をするかを定義する説明。この説明はNetScaler Consoleに表示されます。
  • display-name: NetScaler Consoleに表示されるStyleBookの記述名。
  • namespace: 名前空間は、名前の衝突を避けるためにStyleBookの一意の識別子の一部を形成します。
  • schema-version: このリリースでは常に「1.0」の値を取ります。
  • version: StyleBookのバージョン番号。StyleBookを更新するときにバージョン番号を変更できます。
name、namespace、およびversionの組み合わせは、システム内でStyleBookを一意に識別します。NetScaler Consoleでは、名前、名前空間、およびバージョンの組み合わせが同じ2つのStyleBookを持つことはできません。ただし、名前とバージョンは同じでも名前空間が異なるStyleBook、または名前空間とバージョンは同じでも名前が異なるStyleBookを持つことはできます。
注
StyleBookを更新し、更新されたバージョン番号を持っているとします。このStyleBookを他のStyleBookで参照している(つまり、インポートしている)場合、インポートされたStyleBookの正しいバージョンを使用するように、他のStyleBookでもバージョン番号を更新してください。

StyleBookのインポート

ヘッダーの後のセクションは「import-stylebooks」と呼ばれます。このセクションでは、現在のStyleBookで参照したい他のStyleBookのネームスペースとバージョン番号を宣言する必要があります。これにより、独自のStyleBookで同じ構成を再構築する代わりに、他のStyleBookをインポートして再利用できます。
この例では、import-stylebooksセクションは次のように記述されています。
import-stylebooks:
 -
  namespace: netscaler.nitro.config
  prefix: ns
  version: "10.5"
すべてのStyleBookは、NITRO構成オブジェクトを直接使用する場合、netscaler.nitro.configネームスペースを参照する必要があります。このネームスペースには、lbvserverなどのすべてのNetScaler NITROタイプが含まれています。ソフトウェアバージョン10.5以降がサポートされているため、StyleBookを使用して、リリース10.5以降を実行している任意のNetScalerインスタンスで構成を作成および実行できます。
import-stylebooksセクションで使用されるプレフィックスは、ネームスペースとバージョンの組み合わせを参照するための短縮形です。この場合、nsはバージョン10.5のnetscaler.nitro.configを参照します。StyleBookの後のセクションでは、インポートされたStyleBookを参照するためにネームスペースとバージョンを使用する代わりに、上記の例のように、選択したプレフィックス文字列(例:ns)を使用できます。
StyleBookで使用されるバージョンは、NetScaler NITROバージョンです。NITROバージョンXに基づいたStyleBookは、バージョンX以降の任意のNetScalerを構成するために使用できます。
注
StyleBookがバージョン10.5以降の任意のNetScalerインスタンスを構成するために使用できるようにするには、Citrixは、最大限の互換性のために、NITRO組み込みStyleBookを直接使用するStyleBook(ネームスペース:netscaler.nitro.config、バージョン:10.5)にNITRO 10.5ネームスペースをインポートすることを推奨します。
他のStyleBookをインポートするStyleBookは、インポートするStyleBookと同じかそれ以上のNITROバージョンに基づいている必要があります。たとえば、NITROバージョン10.5に基づいたStyleBookは、11.1に基づいたStyleBookに依存したり、使用したり、インポートしたりすることはできません。しかし、バージョン11.1に基づいたStyleBookは、11.1より前の任意のバージョンに基づいたStyleBookをインポートできます。
NITROネームスペースをまったくインポートしないStyleBookも可能です。つまり、StyleBookはNITROコンポーネントを直接定義する必要はなく、NITROコンポーネントを定義するStyleBookをインポート(依存)できます。他のStyleBookをインポートするStyleBookは、その依存関係の階層内で常に最高のNITROバージョンを取得します。そして、そのバージョン以降のNetScalerを構成するために使用されます。

パラメータ

パラメータセクションでは、StyleBookで必要となるすべてのパラメータを宣言できます。StyleBook開発者として、StyleBookのユーザーにどのような入力を指定してほしいかを決定する必要があります。この例では、仮想サーバーの名前、そのIPアドレス、および負荷分散方法をユーザーが提供する必要があるようにStyleBookを構築しています。
パラメータセクションは次のようになります。
parameters:
 -
  name: name
  label: "Application Name"
  description: "Give a name to the application configuration."
  type: string
  required: true
 -
  name: vip-ipaddress
  label: "Load Balancer IP Address"
  description: "The Application VIP that clients access"
  type: ipaddress
  required: true
 -
  name: lb-alg
  label: LB Algorithm
  description: Load Balancing Algorithm
  type: string
  default: ROUNDROBIN
  allowed-values:
   - ROUNDROBIN
   - LEAST-CONNECTION
注
パラメータのラベルを指定しない場合、NetScaler Consoleはこのパラメータを表示する際に名前属性を使用します。NetScaler Consoleでの表示方法を制御できるように、パラメータには常にラベルを定義する必要があります。
ただし、APIを使用する場合、パラメータはその名前で指定されます。
このセクションでは、仮想サーバー名にはname、仮想サーバーのIPアドレスにはip、ロードバランシング方式にはlb-algというように、name属性値で示される3つのパラメーターを宣言しました。
  • typeは、これらのパラメーターが取りうる値の型を指します。例えば、nameとlb-algは文字列値を取ることができ、IP値はIPアドレス型である必要があります。StyleBookのパラメーターは、以下の組み込み型のいずれかになります。
  • string: 文字の配列。長さが指定されていない場合、文字列値は任意の数の文字を取ることができます。ただし、min-lengthおよびmax-length属性を使用することで、文字列型の長さを制限できます。
  • number: 整数。min-valueおよびmax-value属性を使用することで、この型が取りうる最小値と最大値を指定できます。
  • boolean: trueまたはfalseのいずれか。また、すべてのリテラルはYAMLによってブール値と見なされることに注意してください(例:YesまたはNo)。
  • ipaddress: 有効なIPv4またはIPv6アドレスを表す文字列。
  • tcp-port: TCPまたはUDPポートを表す0から65535までの数値。
  • パスワード: 不透明な/秘密の文字列値です。NetScaler Consoleがこのパラメータの値を表示する場合、アスタリスク (*****) として表示されます。
  • certfile: 証明書ファイル。
  • keyfile: 証明書秘密鍵ファイル。
  • file: この型のパラメーターは、ユーザーがファイル(例:証明書またはキーファイル)をアップロードすることを要求します。
  • object: 複数の要素で構成され、これらの各要素はパラメーターです。この型は、複数の関連するパラメーターを1つの親パラメーターの下にグループ化するために使用できます。
  • required: パラメーターが必須かオプションかを示します。trueに設定されている場合、そのパラメーターは必須であり、ユーザーはこのStyleBookを使用して構成を作成する際に、このパラメーターの値を指定する必要があります。デフォルトでは、すべてのパラメーターはオプションです。この例では、nameとipは必須パラメーターであり、lb-algはオプションパラメーターで、そのデフォルト値は「ROUNDROBIN」です。
オプションパラメーターにデフォルト値を割り当てるには、default属性を使用します。構成を作成する際に、ユーザーが値を指定しない場合、デフォルト値が使用されます。例えば、lb-algパラメーターの場合、デフォルト値はROUNDROBINです。
構成を作成する際にユーザーが選択できる特定の値を定義するには、allowed-values属性を使用します。この例では、lb-algパラメーターにROUNDROBINとLEASTCONNECTIONの2つの値を指定しました。
StyleBookをインポートして使用すると、NetScaler Consoleにはこれら3つのパラメータを含むフォームが表示されます。名前とIPに表示されるフィールドには文字列とipaddressタイプの値を入力でき、lb-algフィールドはドロップダウンリストとして表示され、ROUNDROBINがデフォルト値として選択されています。
注
組み込みタイプに加えて、パラメータは別のStyleBookをそのタイプとして持つことができます。これは、他のStyleBookで定義されたパラメータを再利用する方法です。

コンポーネント

このStyleBookの最後のセクションはコンポーネントセクションと呼ばれ、StyleBookの中で最も重要なセクションと見なされます。このセクションでは、StyleBookによって作成される必要がある構成オブジェクトを定義します。
この例では、コンポーネントセクションを次のように記述する必要があります。
components:
 -
  name: lbvserver-comp
  description: This StyleBook component (a Builtin Nitro StyleBook) builds a NetScaler lbvserver configuration object.
  type: ns::lbvserver
  properties:
   name: $parameters.name
   ipv46: $parameters.vip-ipaddress
   lbmethod: $parameters.lb-alg
   servicetype: HTTP
   port: 80
この例には1つのコンポーネントのみが含まれています。コンポーネントの主な属性は、名前、タイプ、およびプロパティです。コンポーネントのタイプは、このコンポーネントが提供するプロパティを決定します。コンポーネントには2つのタイプがあります。
  • 組み込みタイプ: このタイプはシステムによって提供され、定義する必要はありません。たとえば、NITROエンティティタイプlbvserverまたはservicegroupなどです。この例では、組み込みコンポーネントタイプを使用しています。
  • 複合タイプ: このタイプは、作成してNetScaler ConsoleにインポートしたStyleBook、またはNetScaler Consoleに付属しているデフォルトのStyleBookです。複合StyleBookの詳細については、複合StyleBookの作成を参照してください。
この例では、lbvserver-compというコンポーネントを定義しました。このコンポーネントはns::lbvserverタイプ(組み込みのNITROタイプ)です。「ns」は、import-stylebooksセクションで指定した名前空間netscaler.nitro.configおよびバージョン10.5を参照するプレフィックスであり、lbvserverはこの名前空間内のNITROリソースです。
ここで定義されているプロパティは、lbvserverリソースの属性です。利用可能なすべてのNetScaler NITROリソースとその属性の詳細については、NetScaler NITRO REST APIドキュメントを参照してください。
このセクションのプロパティには、lbvserverリソースの必須属性が含まれており、これらの属性の値を指定できます。この例では、servicetypeとポートに静的な値を指定し、名前、ipv46、およびlbmethodプロパティは入力パラメータから値を取得します。StyleBookの残りの部分では、**$parameters.\<parameter-name\>**式(例: $parameters.ip)を使用して、parametersセクションで定義されたパラメータ名を参照できます。
注
慣例として、「ns」というプレフィックスは、「import-stylebooks」セクションでNetScaler NITRO名前空間を指定するために常に使用されます。必須ではありませんが、Citrixは一貫性のために独自のStyleBookでも同じ慣例を使用することを推奨しています。

StyleBookを構築する

このStyleBookの必要なセクションをすべて定義したので、それらをまとめて最初のStyleBookを構築します。StyleBookの内容をテキストエディターにコピーして貼り付け、ファイルをlb-vserver.yamlとして保存します。Citrixは、YAMLコンテンツを検証およびインポートするために、StyleBooksに組み込まれているYAMLバリデーターを使用することを推奨します。
ファイルlb-vserver.yamlの全内容は以下のとおりです。
name: lb-vserver
namespace: com.example.stylebook
version: "1.0"
display-name: Load Balancing Virtual Server (HTTP)
description: "This stylebook defines a very simple load balancing HTTP virtual server configuration"
schema-version: "1.0"

import-stylebooks:
 -
  namespace: netscaler.nitro.config
  version: "10.5"
  prefix: ns
 -
  namespace: com.citrix.adc.stylebooks
  version: "1.0"
  prefix: stlb

parameters:
 -
  name: name
  label: "Application Name"
  description: "Give a name to the application configuration."
  type: string
  required: true
 -
  name: vip-ipaddress
  label: "Load Balancer IP Address"
  description: "The Application VIP that clients access"
  type: ipaddress
  required: true
 -
  name: lb-alg
  label: LB Algorithm
  description: Load Balancing Algorithm
  type: string
  default: ROUNDROBIN
  allowed-values:
   - ROUNDROBIN
   - LEAST-CONNECTION

components:
 -
  name: lbvserver-comp
  description: This StyleBook component (a Builtin Nitro StyleBook) builds a NetScaler lbvserver configuration object.
  type: ns::lbvserver
  properties:
   name: $parameters.name
   ipv46: $parameters.vip-ipaddress
   lbmethod: $parameters.lb-alg
   servicetype: HTTP
   port: 80
StyleBookを使用して構成を作成するには、NetScaler Consoleにインポートしてから使用する必要があります。詳細については、「ユーザー定義StyleBookの使用方法」を参照してください。
このStyleBookを他のStyleBookにインポートすることもできます(import-stylebooksコンストラクトを使用)。または、次のセクションで説明するように、このStyleBookを修正して、より多くのパラメーターとコンポーネントを含めることもできます。