Citrix Application Delivery Managementサービス

カスタムスタイルブックの作成と使用

展開用に独自のStyleBookを作成し、Citrix Application Delivery Management(ADM)にインポートして、構成オブジェクトを作成できます。また、APIを使用して、StyleBookから構成を作成することもできます。

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

はじめに

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

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

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

  • YAMLでは、大文字と小文字が区別されます。
  • YAMLでは、インデントを適切に使用する必要があります。
  • 適切なインデントを作成するには、 <spacebar> キーを使用します。<tab>キーは使用しないでください。<tab> キーを使用すると、StyleBookをMA Serviceにインポートする際にコンパイルエラーが発生します。
  • 文字列を引用符で囲まないでください。文字列が句読点(ダッシュ、コロン、その他)を含む場合にのみ、文字列を引用符で囲ってください。数字を文字列として解釈する必要がある場合は、数字を引用符で囲むか、またはStyleBookの組み込み関数str()を使用します。
  • Yes/Yes/Yes/Y/Y/No/No/N/N、ON/ON/ON/OFF/OFF、および真/真/真/真/偽/偽/偽のようなリテラルはブール値とみなされ、それぞれ真と偽に相当します。これらのリテラルを文字列として解釈するには、引用符で囲んでください。例:

    • 「YES」
    • 「いいえ」
    • 「真」
    • 「偽」など。

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

StyleBooksの設定中は、 作成および削除操作(POSTおよびDELETE HTTPメソッド)をサポートするNITRO 構成リソースのみを使用できます。詳しくは、「NITRO APIのドキュメント」を参照してください。

StyleBookの構造

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

  • ヘッダー:このセクションでは、StyleBookのアイデンティティを定義し、それが何をしているのかを説明します。これは必須セクションです。
  • Import StyleBooks:このセクションでは、現在のStyleBookから参照する他のStyleBookを宣言できます。スタイルブックを作成するためには、Citrix ADC NITRO 構成スタイルブックまたはその他のスタイルブックをインポートする必要があります。これは必須セクションです。
  • 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 でAnalyticsを有効にするオプションのセクションを含めることができます。

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

StyleBookのアウトライン

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

カスタムスタイルブックの作成と使用