カスタムStyleBookの作成と使用

最終公開日 : Oct 02, 2026
展開用の独自のStyleBookを作成し、NetScaler Consoleにインポートして、構成オブジェクトを作成できます。APIを使用して、StyleBookから構成を作成することもできます。
このドキュメントには、次の情報が含まれています。
Related information
StyleBooks
構成パックの作成と編集ロードバランシング仮想サーバーを作成するためのStyleBook基本的なロードバランシング構成を作成するためのStyleBook複合StyleBookを作成するカスタムStyleBookでGUI属性を使用するカスタムStyleBookのインポートファイルをアップロードするためのStyleBookを作成するSSL証明書と証明書キーファイルをアップロードするためのStyleBookを作成するStyleBook を使用して証明書ストアから SSL 証明書を管理するStyleBookで定義された仮想サーバーでアナリティクスを有効にし、アラームを設定するインスタンスの役割非CRUD操作を実行するStyleBookを作成するDNSドメイン名を使用したGSLB構成の展開StyleBookで特殊文字をリテラル形式で許可する

開始する前に

StyleBookの作成を開始する前に、次の知識があることを確認してください。
  • NITRO API。詳細については、NITRO APIドキュメントを参照してください。
  • YAML
StyleBookファイルはYAML形式を使用します。YAML形式の詳細については、YAML構文を参照してください。
StyleBookを作成する際に注意すべきYAMLガイドラインのリストを次に示します。
  • YAMLは大文字と小文字を区別します。
  • YAMLには適切なインデントが必要です。
  • 適切なインデントを作成するには、<spacebar>キーを使用します。<tab>キーは使用しないでください。<tab>キーを使用すると、StyleBookをMAサービスにインポートする際にコンパイルエラーが発生します。
  • 文字列を引用符で囲まないでください。文字列に句読点（ダッシュ、コロンなど）がある場合にのみ、文字列を引用符で囲んでください。数値を文字列として解釈したい場合は、数値を引用符で囲むか、StyleBookのstr()組み込み関数を使用してください。
  • YES/Yes/yes/Y/y/NO/no/No/n/N、ON/On/on/OFF/Off/off、TRUE/true/truthy/FALSE/False/false/falselyのようなリテラルはブール値と見なされ、それぞれtrueとfalseに相当します。これらを文字列として解釈するには、引用符で囲んでください。例：
    • "YES"
    • 「いいえ」
    • 「真」
    • 「False」など。
注
NetScaler ConsoleにStyleBookファイルをインポートする前に、ファイルがYAML形式に準拠していることを検証することをお勧めします。Citrixは、YAMLコンテンツを検証およびインポートするために、StyleBooksに組み込まれているYAMLバリデーターを使用することを推奨しています。
詳細については、NITRO APIドキュメントを参照してください。

StyleBookの構造

StyleBookを作成するには、StyleBookの文法、構文、および構造を理解する必要があります。一般的なStyleBookには、次のセクションがあります。
  • ヘッダー: このセクションでは、StyleBookのIDを定義し、その機能について説明します。これは必須セクションです。
  • StyleBookのインポート: このセクションでは、現在のStyleBookから参照したい他のStyleBookを宣言します。StyleBookを作成するには、NetScaler NITRO構成StyleBookまたは他のStyleBookをインポートする必要があります。これは必須セクションです。
  • パラメーター: このセクションでは、構成を作成するためにStyleBookで必要となるパラメーターを定義します。StyleBookが受け取る入力を記述します。これはオプションのセクションです。
  • コンポーネント: このセクションでは、特定の構成のためにStyleBookによって作成されるエンティティ（構成オブジェクト）を定義します。このセクションはStyleBookの核と見なされます。コンポーネントは通常、パラメーターセクションで提供される入力を使用して、StyleBookによって生成される構成を調整します。これはオプションのセクションです。StyleBookには、パラメーターセクション、コンポーネントセクション、またはその両方を含めることができます。パラメーターセクションのみを持つStyleBookは、他のStyleBookで使用できるパラメーターのリストを定義するのに役立ちます。これにより、StyleBookのセット全体でパラメーターグループの再利用性が促進されます。コンポーネントセクションのみを持つStyleBookは、ユーザー入力を受け取るパラメーターを定義する代わりに、StyleBook内の属性の値を指定したい場合に使用できます。
  • 出力: パラメーターセクションがStyleBookの入力を定義するのに対し、このオプションのセクションはその出力を定義します。このオプションの出力セクションでは、このStyleBookから構成を作成するユーザーや、このStyleBookをインポートする他のStyleBookに公開したいコンポーネントを指定できます。ユーザーやインポートするStyleBookは、公開されたコンポーネントのプロパティを参照できるようになります。
  • 操作: StyleBookには、StyleBookの一部である仮想サーバーでNetScaler ConsoleのAnalyticsを有効にするためのオプションセクションを含めることができます。
次の図は、StyleBookの簡単な概要を示しています。
StyleBookの概要(/en-us/netscaler-console-service/media/stylebook-outline.png)
以下の例は、StyleBookの文法と構造、および複雑さのレベルを上げてStyleBookを作成する方法を学ぶのに役立ちます。
  • 負荷分散仮想サーバーを作成するためのStyleBook(/ja-jp/netscaler-console-service/stylebooks/how-to-create-custom-stylebooks/create-load-balancing-virtual-server.html)
  • 基本的な負荷分散構成を作成するためのStyleBook(/ja-jp/netscaler-console-service/stylebooks/how-to-create-custom-stylebooks/create-basic-load-balancing-configuration.html)
  • 複合StyleBookを作成する(/ja-jp/netscaler-console-service/stylebooks/how-to-create-custom-stylebooks/create-composite-stylebook.html)
  • GUI属性を使用してStyleBookをカスタマイズする(/ja-jp/netscaler-console-service/stylebooks/how-to-create-custom-stylebooks/use-gui-attributes.html)