カスタムStyleBookの作成と使用
独自のStyleBookを作成して展開し、NetScaler® Application Delivery Management (ADM) にインポートして、構成オブジェクトを作成できます。API を使用して、StyleBook から構成を作成することもできます。
このドキュメントには、次の情報が含まれています。
Related information
スタイルブック
ロードバランシング仮想サーバーを作成するためのStyleBook基本的なロードバランシング構成を作成するためのStyleBook複合StyleBookの作成カスタムStyleBookでのGUI属性の使用カスタムStyleBookのインポート設定パックを作成および編集するNetScaler® ADMにファイルをアップロードするためのStyleBookを作成するNetScaler ADMにSSL証明書と証明書キーファイルをアップロードするためのStyleBookを作成するStyleBookで定義された仮想サーバーでアナリティクスを有効にし、アラームを設定するインスタンスロール非CRUD操作を実行するStyleBookを作成するStyleBookの構成パックを別の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」
-
「いいえ」
-
「真」
-
「偽」など。
-
注
NetScaler ADMにStyleBookファイルをインポートする前に、ファイルがYAML形式に準拠していることを検証することをお勧めします。Citrixは、YAMLコンテンツを検証およびインポートするために、StyleBooksに組み込まれているYAMLバリデーターを使用することを推奨しています。
StyleBookを設定する際、作成および削除操作（POSTおよびDELETE HTTPメソッド）をサポートするNitro構成リソースのみを使用できます。詳細については、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 ADMのAnalyticsを有効にするためのオプションセクションを含めることができます。
次の図は、StyleBook の簡単な概要を示しています。
次の例は、StyleBook の文法と構造、および複雑さのレベルを上げて StyleBook を記述する方法を学ぶのに役立ちます。