カスタムStyleBookをインポートする

最終公開日 : Sep 25, 2026
StyleBookを構築したら、NetScaler Consoleにインポートして使用します。NetScaler Consoleでは、単一のStyleBookをYAML形式でインポートしたり、複数のStyleBook YAMLファイルを.zip、.tgz、または.gz形式のバンドルとしてインポートしたりできます。NetScaler Consoleシステムは、インポート時にStyleBookを検証します。これで、StyleBookは構成の作成に使用できるようになります。
NetScaler Consoleには、StyleBookのYAMLコンテンツを作成するために使用できる組み込みのYAMLエディターも用意されています。YAMLエディターを使用すると、NetScaler Console GUI自体からYAML構造を検証できます。これらの検証チェックのために別のツールを使用する必要はありません。コンテンツはYAML標準に対して検証され、逸脱がある場合は強調表示されます。その後、コンテンツを修正し、StyleBookをNetScaler Consoleにインポートできます。組み込みのYAMLエディターは、独自のStyleBookを作成する際に2つの利点を提供します。
  • 色分け。エディターは、YAMLガイドラインに従って解析されたStyleBookコンテンツを表示します。色分けにより、YAMLコンテンツで定義されているキーと値を簡単に区別できます。
  • YAML検証。入力中にYAMLエラーがないかコンテンツが検証され、逸脱がある場合はすぐに強調表示されます。この検証により、NetScaler ConsoleにStyleBookをインポートする前でも、YAMLガイドラインに準拠したテキストを作成できます。
注:
現在、エディターはYAMLガイドラインに従ってコンテンツを検証します。コードの正確性や誤植は検証しません。

StyleBookの説明とヘッダーでHTML書式設定タグを使用する

StyleBook定義では、ヘッダーフィールドを含め、テキストにHTML書式設定タグを使用できます。ヘッダーの一部として画像を含めることもできます。ヘッダーフィールドのHTMLコンテンツは、構成を作成または更新する際に構成ページの上部に表示されます。この機能により、StyleBookの構成を理解するのに役立つインフォグラフィックをStyleBookに追加できます。ヘッダーに画像を使用する場合は、<img>タグでbase64エンコードされた画像形式を使用してください。
HTMLコンテンツで画像を使用するには、次の例に示すように画像をインラインにする必要があります。オンラインツールを使用して、画像をbase64エンコード形式に変換できます。
name: cs-example
namespace: com.example.stylebooks
version: "1.2"
display-name: Content Switching Configuration
description: Example of a very simple content switching config that creates and binds an lb to a cs
header:  <img id="b64img" src="data:image/png;base64,…" />
     <h3>Operations performed by this StyleBook:</h3>
     <ul>
      <li style="list-style-type: circle"> Creates a Server </li>
      <li style="list-style-type: circle"> Creates a Service Group </li>
       <li style="list-style-type: circle"> Creates a LBVServer </li>
      <li style="list-style-type: circle"> Creates a CS Policy and Action </li>
     </ul>
schema-version: "1.0"

StyleBookをインポートするには

  1. NetScaler Consoleで、Applications > Configuration > StyleBooks に移動し、Import New StyleBook をクリックします。
  2. StyleBookをインポートするには、次のいずれかのオプションをクリックします。
    • ファイル - ローカルストレージから必要なファイルまたはファイルのバンドルを選択します。
      注:
      この例では、StyleBook to Create a Load Balancing Virtual Serverで作成したlb-vserver.yml StyleBookをインポートします。
      StyleBookファイルをインポート(/en-us/netscaler-console-service/media/nmas-stylebooks-yaml-editor-1.png)
    • バンドル - NetScaler Consoleでは、YAML形式の多くのStyleBookをインポートできます。zip (.zip) 形式またはtarball (.tgz, .gz) 形式で圧縮された複数のYAML StyleBookファイルをインポートできます。
      StyleBookバンドルをインポート(/en-us/netscaler-console-service/media/nmas-stylebooks-yaml-editor-5.png)
      NetScaler ConsoleにインポートされたStyleBookは、StyleBooks GUIにデフォルトのアイコンで表示されます。これらのデフォルトアイコンは、独自の画像でカスタマイズできます。
      これを行うには、:
      • StyleBook YAMLファイルがあるフォルダーの下に、resourcesという名前のフォルダーを作成します。
      • アイコンをresourcesフォルダーにアップロードします。
      注:
      resourcesフォルダーの名前を他の名前に変更することはできません。
      • アイコンファイルとそれに対応するStyleBookファイルの名前が同じ場合、アイコンは自動的にStyleBookにマッピングされます。
      • アイコンファイルとそれに対応するStyleBookファイル（例：exchange.yamlとexch.png）が一致しない場合は、resourcesフォルダーに「icon_mapping.json」という名前のJSONファイルを次のように作成します。
      <StyleBook file name> : <icon file name>
      <StyleBook file1 name> : <icon file1 name>
      <StyleBook file2 name> : <icon file2 name>
      以下はStyleBookバンドルの例です。
      アイコン付きのStyleBookバンドル(/en-us/netscaler-console-service/media/stylebook-icons-bundle.png)
      resourcesフォルダーには必要なアイコンが含まれています。
      リソースフォルダー内のアイコン
      この例では、sharepoint.yaml と skype.yaml ファイルは、それぞれ sharepoint.jpeg と skype.png に自動的にマッピングされます。
      exchange.yaml を exch.png にマッピングするには、icon_mapping.json ファイルで次のように指定します。
      {
      "exchange.yaml":"exch.png"
      }
      StyleBookバンドルにアイコンがない場合、デフォルトのアイコンが表示されます。
    • Raw - YAMLエディターでStyleBookのコンテンツを作成します。
      StyleBookのコンテンツを検証して、StyleBookの文法エラーを確認できます。StyleBookのコンテンツを検証するには、Validate Contents をクリックします。
      注:
      StyleBookを作成する際は、以下の概念を理解していることを確認してください。
      • NITRO API
      • YAML
      独自のStyleBookの作成方法の詳細については、「How to Create Your Own StyleBooks」を参照してください。
      NetScaler Console YAMLエディターを使用してStyleBookを作成する
      注:
      お気に入りのエディターでStyleBookを作成し、そのコンテンツをYAMLエディターにコピーして貼り付け、検証およびインポートすることもできます。
    • Sync Repository - GitHubでStyleBookを作成および管理している場合は、このオプションを使用して、NetScaler Consoleがリポジトリ内の新規または更新されたStyleBookを検出できるようにします。NetScaler Consoleと同期するリポジトリを選択します。
  3. 任意で、StyleBookのアイコンを選択します。
    Applications > Configuration > StyleBooksで、インポートされたStyleBookがこのアイコンとともに表示されます。
  4. 作成をクリックします。
    NetScaler Consoleは、StyleBookの文法に従って、構文エラーと意味エラーがないかStyleBookを検証します。エラーがある場合、StyleBookはNetScaler Consoleにインポートされません。
    エラーがない場合、StyleBookは正常にインポートされ、StyleBooksページに表示されます。StyleBookのヘッダーセクションで定義した表示名でStyleBookを識別できます。
    注:
    ファイルのバンドルをインポートする場合、NetScaler Consoleは圧縮されたフォルダーを解凍し、すべてのStyleBookを検証します。 1つのStyleBookファイルが検証テストに失敗した場合でも、バンドルはインポートされません。
    StyleBookの文法、およびさまざまな構成要素と属性の構文の詳細については、StyleBookの文法を参照してください。
  5. このStyleBookから構成を作成するには、構成の作成リンクをクリックします。
    StyleBookページが開き、このStyleBookで定義されているすべてのパラメーターの値を入力できます。
  6. パラメーターに必要な値を指定します。
    次の例では、,
    1. アプリケーション名とロードバランサーのIPアドレスの必須フィールドを指定します。
    2. リストから負荷分散アルゴリズムを選択します。デフォルトでは、ROUNDROBINが選択されています。
  7. ターゲットインスタンスで、構成を展開するNetScalerインスタンスのIPアドレスを選択します。
    必要な数のターゲットインスタンスを指定することで、複数のNetScalerに構成を展開することもできます。
    注:
    NetScaler Consoleで最近検出されたすべてのNetScalerインスタンスをターゲットインスタンスに追加するには、StyleBooksページに移動し、ページの右側にある更新アイコンをクリックします。
  8. 構成を展開する前にNetScaler (NITRO) 構成オブジェクトをテストしたい場合は、ドライランをクリックします。
    構成が有効な場合、指定された値に基づいて構成オブジェクトが作成されます。
    この例では、StyleBookはタイプlbvserverのオブジェクトを1つだけ作成します。このロードバランシングサーバーは、この基本的な例のStyleBookで定義された唯一のコンポーネントでした。
    その後、作成をクリックして、選択したNetScalerインスタンスに構成を展開します。
構成を正常に展開すると、構成ページに新しい構成パックが表示されます。