StyleBookの設定

カスタムStyleBookの作成と使用

デプロイメント用に独自のStyleBookを作成し、NetScaler ADM にインポートして、構成オブジェクトを作成できます。API を使用してスタイルブックから構成を作成することもできます。

このドキュメントでは、次の内容について説明します。

はじめに

StyleBookの作成を始める前に、次の知識があることを確認してください。

StyleBookファイルではYAML形式を使用します。YAML 形式の詳細については、「 YAML 構文」を参照してください。

StyleBookを作成するときは、次に示すYAMLのガイドラインに注意する必要があります。

  • YAMLでは、大文字と小文字が区別されます。
  • YAMLでは、インデントを適切に使用する必要があります。
  • <spacebar> キーを使用して適切なインデントを作成してください。 <tab> キーは使用しないでください。<tab>キーを使用すると、StyleBookをMAサービスにインポートする際にコンパイルエラーが発生します。
  • 文字列を引用符で囲まないでください。文字列に句読点 (ダッシュ、コロンなど) がある場合にのみ、文字列を引用符で囲んでください。数値を文字列として解釈したい場合は、数字を引用符で囲むか、StyleBooksのstr () 組み込み関数を使用してください。
  • YES/Yes/yes/Y/y/NO/no/No/n/N、ON/On/on/OFF/Off/off,、TRUE/true/truthy/FALSE/False/false/falselyなどのリテラルはブール値と見なされ、それぞれ真と偽と同等です。これらのリテラルを文字列として解釈するには、引用符で囲んでください。例:

    • “YES”
    • “No”
    • “True”
    • “False” など。

StyleBookファイルをCitrix ADM にインポートする前に、ファイルがYAML形式に準拠しているかどうかを確認することをお勧めします。StyleBooksに組み込みのYAMLバリデータを使用して、YAMLコンテンツを検証およびインポートすることをお勧めします。

詳細については、 NITRO API のドキュメントを参照してください

StyleBookの構造

StyleBookを作成するには、StyleBookの文法、構文、および構造を理解する必要があります。通常、StyleBookには、次のセクションが含まれます。

  • ヘッダー:このセクションでは、StyleBookのアイデンティティを定義し、その機能を説明できます。これは必須セクションです。
  • Import StyleBooks:このセクションでは、現在のStyleBookから参照する他のStyleBookを宣言できます。StyleBookを作成するには、NetScaler NITRO構成のStyleBooksまたは他のStyleBookをインポートする必要があります。これは必須セクションです。
  • Parameters:このセクションでは、構成を作成するために必要なStyleBookのパラメーターを定義します。StyleBookでは、このセクションに記述された入力が使用されます。これはオプションのセクションです。
  • コンポーネント:このセクションでは、特定の構成用にStyleBookによって作成されるエンティティ (構成オブジェクト) を定義できます。このセクションは、StyleBookの中核です。Componentsでは通常、Parametersセクションの入力値を使用して、StyleBookで生成される構成に適応させます。これはオプションのセクションです。
    StyleBookには、ParametersセクションとComponentsセクションのいずれか、または両方を記述できます。他のStyleBookで使用可能なパラメーターの一覧を定義する場合、Parametersセクションのみを含むStyleBookを作成すると便利です。これにより、一連のStyleBook全体で、パラメーターグループが再利用しやすくなります。ユーザー入力を取得するパラメーターを定義せずに、StyleBookの属性値を指定する場合は、Componentsセクションのみを含むStyleBookを使用します。
  • Outputs:Parametersセクションでは、StyleBookの入力を定義しましたが、この省略可能なOutputsセクションではStyleBookの出力を定義します。構成を作成するユーザーは、この省略可能なOutputsセクションで指定したコンポーネントを、このStyleBookから、このStyleBookをインポートする他のStyleBookに公開できます。これにより、ユーザーおよびインポートする側のStyleBookは、公開されたコンポーネントのプロパティを参照できます。
  • 操作:StyleBookには、StyleBookの一部である任意の仮想サーバー上のCitrix ADM でアナリティクスを有効にするオプションセクションが含まれている場合があります。

次の図は、StyleBookの概略を簡単に示したものです。

StyleBookのアウトライン

次の例は、StyleBookの文法と構文について学び、より複雑なStyleBookの作成方法を理解するのに役立ちます。

カスタムStyleBookの作成と使用

この記事の概要