Citrix Application Delivery Management 13.0

パラメーター

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

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

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

名前

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

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

StyleBookを記述する場合、この「name」属性を使用して、$parameters.<name>という表記を使用して、他のセクションのパラメータを参照できます。

必須? はい

ラベル

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構成を作成するときに、ローカルシステムからファイルを直接アップロードできます。アップロードされた証明書ファイルは、ADM の /var/mps/tenants/<tenant_path>/ns_ssl_certs ディレクトリに保存されます。

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

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

    証明書キーファイルは、Citrix ADM によって管理される証明書キーの一覧に追加されます。

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

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

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

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

必須? はい

key

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

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

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

デフォルト値はfalseです。

必須? いいえ

必須

trueまたはfalseを指定して、パラメーターが必須か、任意かを示します。true に設定されている場合、パラメータは必須です。デフォルト値が定義されていない限り、構成を作成するには、必須パラメータの値を指定する必要があります。

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

デフォルト値はfalseです。

必須? いいえ

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

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

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

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

allowed-values

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

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

例 1:

 -
   name: ipaddress
   type: string
   allowed-values:
     -  SOURCEIP
     -  DEST IP
     -  NONE
<!--NeedCopy-->

例 2:

 -
   name: TCP Port
   type: tcp-port
   allowed-values:
     -  80
     -  81
     -  8080
<!--NeedCopy-->

例 3:

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

  -
    name: tcpports
    type: tcp-port[]
    allowed-values:
      -  80
      -  81
      -  8080
      -  8081
<!--NeedCopy-->

必須? いいえ

デフォルト

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

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

例 1:

  -
    name: timeout
    type: number
    default: 20
<!--NeedCopy-->

例 2:

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

  -
    name: protocols
    type: string[]
    default:
      - TCP
      - UDP
      - IP
<!--NeedCopy-->

例 3:

  -
    name: timeout
    type: number
    default: 20
<!--NeedCopy-->

例 4:

  -
    name: tcpport
    type: tcp-port
    default: 20
<!--NeedCopy-->

必須? いいえ

pattern

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

:

  -
    name: appname
    type: string
    pattern: "[a-z]+"
<!--NeedCopy-->

必須? いいえ

min-value

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

:

  -
    name: audio-port
    type: tcp-port
    min-value: 5000
<!--NeedCopy-->

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

必須? いいえ

max-value

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

最大値は、定義されている場合、最小値よりも大きくする必要があります。

:

  -
    name: audio-port
    type: tcp-port
    min-value: 5000
    max-value: 15000
<!--NeedCopy-->

必須? いいえ

min-length

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

値として定義される文字の最小長は、ゼロ 以上にする必要があります。

:

  -
    name: appname
    type: string
    min-length: 3
<!--NeedCopy-->

必須? いいえ

max-length

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

値の最大長は、 min-length で定義された文字の長さ以上である必要があります。

:

  -
    name: appname
    type: string
    max-length: 64
<!--NeedCopy-->

必須? いいえ

min-items

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

アイテムの最小数は、ゼロ以上にする必要があります。

:

  -
    name: server-ips
    type: ipaddress[]
    min-items: 2
<!--NeedCopy-->

必須? いいえ

max-items

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

項目の最大数は、項目の最小数よりも大きくする必要があります (定義されている場合)。

:

  -
    name: server-ips
    type: ipaddress[]
    min-items: 2
    max-items: 250
<!--NeedCopy-->

必須? いいえ

gui

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

必須? いいえ

columns

これはgui属性のサブ属性です。この属性は、オブジェクトタイプリストのパラメータに使用されます。これらのパラメータは、GUI にテーブルとして表示されます。各行はリスト内の 1 つのオブジェクトを表し、列はオブジェクトキーを表します。これを使用して、Citrix ADM GUIに表示する列数を定義します。

デフォルトでは、文字列型のすべてのオブジェクトキーが表示されます。

必須? いいえ

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-->

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

  -
    name: features-list
    type: string[]
    min-length: 1
    max-length: 3
    min-items: 1
    max-items: 3
    pattern: "[A-Z]+"
    allowed-values:
     - SP
     - LB
     - CS
    default:
     - LB
<!--NeedCopy-->
パラメーター