Application Delivery Management

パラメーター

このセクションでは、構成を作成するために必要なStyleBookのすべてのパラメーターを定義します。StyleBookでは、このセクションに記述された入力が使用されます。このセクションはオプションですが、ほとんどのStyleBookで必要になります。StyleBookを使用してCitrix ADC インスタンスで構成を作成するときにユーザーに回答してもらいたい質問を定義するには、パラメーターセクションを検討してください。

StyleBookをCitrix ADM にインポートして構成を作成すると、GUIはStyleBookのこのセクションを使用して、定義したパラメーターの値を入力するフォームを表示します。

次のセクションでは、このセクションの各パラメータに指定する必要がある属性について説明します。

name

定義するパラメーターの名前。英数字名を指定できます。

名前はアルファベットで始まる必要があり、追加でアルファベット、数字、ハイフン(-)、またはアンダースコア(_)を含めることができます。

StyleBookの作成時に、この「name」属性を使用して、$parameters.<名前>という表記でほかのセクションのパラメーターを参照できます。名前>

必須? はい

ラベルに貼り付けます

ADM GUI でこのパラメータの名前として表示される文字列。

必須? いいえ

説明

パラメーターの使用目的について説明するヘルプ文字列。ユーザーがこのパラメータのヘルプアイコンをクリックすると、ADM GUI にこのテキストが表示されます。

必須? いいえ

種類

そのパラメーターで使用できる値のタイプ。パラメータには、 次の組み込み型のいずれかを使用できます。

  • string:文字の配列。長さが指定されていない場合、文字列値には、任意の数の文字を使用できます。ただし、min-length属性とmax-length属性を使用すれば、文字列タイプの長さを制限できます。

  • number:整数。min-value属性とmax-value属性により、このタイプで使用できる最小数と最大数を指定できます。

  • boolean:trueとfalseのいずれかを設定できます。YAMLでは、すべてのリテラルがブール値(例:YesまたはNo)と見なされることに注意してください。

  • ipaddress:有効なIPv4アドレスまたはIPv6アドレスを示す文字列。

  • tcp-port:TCPポートまたはUDPポートを示す0~65535の数値。

  • password:不透明な秘密の文字列値を表します。Citrix ADM GUIにこのパラメーターの値が表示される場合、アスタリスク(*****)として表示されます。

  • certfile:証明書ファイルを表します。これにより、ADM GUIを使用してStyleBook構成を作成するときに、ローカルシステムからファイルを直接アップロードできます。アップロードされた証明書ファイルは /var/mps/tenants/ ディレクトリに保存されますADM の /ns_ssl_certs。

    証明書ファイルは、ADM が管理する証明書のリストに追加されます。

  • keyfile:証明書キーファイルを表します。これにより、Citrix ADM GUIを使用してStyleBook構成を作成するときに、ローカルシステムからファイルを直接アップロードできます。アップロードされた証明書ファイルは /var/mps/tenants/ ディレクトリに保存されますCitrix ADM の /ns_ssl_keys。

    証明書キーファイルは、Citrix ADM が管理する証明書キーのリストに追加されます。

  • file:ファイルを表します。

  • object:このタイプは、関連する複数のパラメーターを1つの親要素の下にグループ化する場合に使用します。親パラメーターのタイプとして「object」を指定する必要があります。タイプが「object」のパラメーターにはネストされた「Parameters」セクションを含めることができ、そのセクションに含まれるパラメーターを記述できます。

  • 別のStyleBook:このタイプのパラメータを使用すると、このパラメータは、その値がStyleBookで定義されているパラメータの型であることを期待します。

パラメータには、型の末尾に「[]」を追加することで、上記 のいずれかの型のリストである型を指定することもできます。たとえば、タイプ属性が string [] の場合、このパラメーターは 文字列のリストを入力として受け取ります。このStyleBookから構成を作成するときに、 このパラメータに文字列を 1 つ、2 つ、または複数の文字列を指定できます。

必須? はい

キー

trueまたはfalseを指定して、このパラメーターがStyleBookのキーパラメーターかどうかを示します。

StyleBookで「キー」パラメーターとして定義できるパラメーターは1つだけです。

同じStyleBookから(同じまたは異なるCitrix ADC インスタンスで)異なる構成を作成すると、各構成でこのパラメーターの値は 異なります。

デフォルト値はfalseです。

必須? いいえ

必須

trueまたはfalseを指定して、パラメーターが必須か、任意かを示します。true に設定した場合、パラメータは必須であり、ユーザーは構成の作成時にこの パラメータの値を指定する必要があります。

NetScaler ADM GUIにより、このパラメーターに有効な値が指定されます。

デフォルト値はfalseです。

必須? いいえ

パラメータにおよびがtype: objectあるrequired: false場合 、このパラメータのサブパラメータは評価されません。

サブパラメータのデフォルト値を有効にする場合は、メインrequired: trueパラメータを次のように設定します 。

    type: object
    required: true
    gui:
      collapse_pane: true
<!--NeedCopy-->

collapse_pane 属性は、ユーザーがペインを展開しない限り、UI でオブジェクトとそのサブパラメーターを折りたたんで表示します。

allowed-values

型が「string」に設定されている場合、この属性を使用して、パラメータの有効な値のリストを定義します。

NetScaler ADM GUIから構成を作成する場合、ユーザーはこのリストからパラメーター値を選択するように求められます。

例 1

名前:IP アドレス

type: string

許容値:

  • SOURCEIP
  • ウエストチップ
  • NONE

例 2

名前:TCP ポート

type: tcp-port

許容値:

  • 80
  • 81
  • 8080

サンプル 3

(tcp-portのリスト。リストの各要素は、許可された値 で指定された値のみを持つことができます)

name: tcpports

タイプ:TCP ポート []

許容値:

  • 80
  • 81
  • 8080
  • 8081

必須? いいえ

デフォルト

任意のパラメーターにデフォルト値を割り当てるには、この属性を使用します。構成の 作成時に、ユーザーが値を指定しない場合、デフォルト値が使用されます。

Citrix ADM GUIから構成を作成するときに、ユーザーがデフォルト値のない パラメーターに値を入力しない場合、そのパラメーターには値が設定 されません。

例 1

名前:タイムアウト

タイプ:番号

デフ・アダルト:20

例 2

(パラメータのデフォルト値は値のリストです):

name: protocols

タイプ:文字列 []

default:

  • TCP
  • UDP
  • IP

サンプル 3

名前:タイムアウト

タイプ:番号

デフ・アダルト:20

例 4:

名前:TCP ポート

type: tcp-port

デフ・アダルト:20

必須? いいえ

pattern

この属性を使用して、パラメータの型が「string」の場合に、この パラメータの有効な値のパターン(正規表現)を定義します。

名前:アプリ名

type: string

パターン:「[A-Z] +」

必須? いいえ

min-value

種類が「number」または「tcp-port」のパラメーターの最小値を定義するには、この属性を使用します。

名前:オーディオポート

type: tcp-port

最小値:5000

数値の最小値は負でもかまいませんが、tcp-port の最小値は 負であってはなりません。

必須? いいえ

max-value

この属性を使用して、「number」または 「tcp-port」タイプのパラメータの最大値を定義します。

定義されている場合、最大値は最小値より大きくなければなりません。

名前:オーディオポート

type: tcp-port

最小値:5000

最大値:15000

必須? いいえ

min-length

この属性を使用して、「string」 タイプのパラメータに受け入れられる値の最小長を定義します。

値として定義される文字の最小長は 0以上でなければ なりません。

名前:アプリ名

type: string

最小長さ:3

必須? いいえ

max-length

種類が「string」のパラメーターに入力できる値の最大文字数を定義するには、 この属性を使用します。

値の最大長は、min-lengthで 定義された文字の長さ以上でなければなりません。

名前:アプリ名

type: string

最大長:64

必須? いいえ

min-items

この属性を使用して、リストであるパラメータ内の項目の最小数 を定義します。

項目の最小数はゼロ以上でなければなりません。

name: server-ips

タイプ:IP アドレス []

min-items: 2

必須? いいえ

max-items

リストであるパラメータ内の項目の最大数を定義するには、 この属性を使用します。

項目の最大数は、定義されている場合は最小項目数より大きくなければなりません。

name: server-ips

タイプ:IP アドレス []

min-items: 2

最大アイテム数:250

必須? いいえ

gui

この属性を使用して、Citrix ADM GUIの「オブジェクト」タイプのパラメータの レイアウトをカスタマイズします。

必須? いいえ

columns

これはgui属性のサブ属性です。これを使用して、Citrix ADMGUIに表示する 列の数を定義します。

必須? いいえ

updatable

これはgui属性のサブ属性です。これを使用して、構成の作成後にパラメーター を更新できるかどうかを指定します。

値をfalseに設定すると、構成の更新時にパラメーターフィールドが灰色表示になります。

必須? いいえ

collapse_pane

これはgui属性のサブ属性です。これを使用して、このオブジェクトパラメータのレイアウト を定義するペインが折りたたみ可能かどうかを指定します。

値をtrueに設定すると、ユーザーはこの親パラメーターの下にある子パラメーターを展開したり折りたたんだりできるようになります。

    gui:

     collapse_pane: true

     columns: 2

     updatable: false
<!--NeedCopy-->

Parametersセクション全体の例:

parameters:

   -

      name: name

      label: Name

      description: Name of the application

      type: string

      required: true

       -

         name: ip

         label: IP Address

         description: The virtual IP address used for this application

         type: ipaddress

         required: true

      -

         name: svc-servers

         label: Servers

         type: object[]

         required: true

         parameters:

            -

               name: svc-ip

               label: Server IP

               description: The IP address of the server

               type: ipaddress

               required: true

                -

                  name: svc-port

                  label: Server Port

                  description: The TCP port of the server

                  type: tcp-port

                  default: 80

      -

          name: lb-alg

          label: LoadBalancing Algorithm

          type: string

          allowed-values:

            - ROUNDROBIN

            - LEASTCONNECTION

          default: ROUNDROBIN

      -

          name: enable-healthcheck

          label: Enable HealthCheck?

          type: boolean

          default: true
<!--NeedCopy-->

次の例では、一覧のすべての属性と、前のセクションで説明した値を定義しています。

```YAML    名:機能リスト

タイプ:文字列 []**

最小長さ:1

最大長:3

最小アイテム:1

最大アイテム数:3

パターン:「[A-Z] +」

    allowed-values:

-小さじ

-ポンド

-個

デフォルト:

-ポンド

パラメーター