パラメーター条件
パラメーター条件は、StyleBook定義内の特定のパラメーターの動作を変更するために使用されます。StyleBook定義のパラメーターは、構成パックを作成するために提供される入力です。定義にパラメータ条件を定義するためにparameters-conditionsを使用します。
StyleBook の定義では、パラメーターに多数の制約を設定できます。パラメーター条件は、ユーザーがパラメーターの動作を変更したときの競合を解決するために使用されます。たとえば、ユーザーが SSL プロトコルを選択した場合、構成パックを作成するには証明書の詳細が必要です。ただし、最初は証明書の詳細が必須フィールドとして設定されていない場合があります。
パラメーター condition には次の属性があります。
-
target: アクションを適用するターゲットパラメータを指定します。ターゲットパラメータは複数指定できます。 -
action: ターゲットパラメータに対して実行するアクションを指定します。パラメーター条件では、次のアクションがサポートされています： -
condition：オプション。指定したターゲットパラメータにアクションを適用する条件を指定します。条件を指定しない場合、アクションはターゲットパラメータに直接適用されます。 -
value: アクションに応じて、ターゲットパラメータ属性の値を設定します。
注：
現在、パラメータ条件はリストオブジェクト内のパラメータには適用できません。
「許容値の拡大」
アクションがaugment-allowed-valuesの場合、ターゲットパラメータは GUI のドロップダウンメニューとして表示されます。ドロップダウンメニューは、StyleBook定義のvalue属性で定義された値で設定されます。
例：
parameters-conditions:
-
target: $parameters.rewritepolicy.action
action: augment-allowed-values
value: $parameters.rewriteaction
<!--NeedCopy-->
「表示」または「非表示」
アクションがshowであり、指定された条件がTrueを戻すと 、target パラメータが GUI に表示されます。
アクションがhideであり、指定された条件がTrueを戻すと 、target パラメータが GUI にから消えます。
例：
parameters-conditions:
-
target: $parameters.security-settings.cert-details
action: show
condition: $parameters.protocol in ["SSL", "SSL-BRIDGE"]
<!--NeedCopy-->
最初は、 security-settings パラメーターの証明書の詳細は非表示になっています。ユーザーが SSL または SSL ブリッジプロトコルを選択すると、証明書の詳細が表示されます。
‘set-default’
アクションがset-defaultであり、指定された条件がTrueを戻すと 、target パラメータが デフォルト値に設定されます。
例 1：
parameters-conditions:
-
target: $parameters.port
action: set-default
condition: $parameters.protocol == "SSL"
value: 443
-
target: $parameters.port
action: set-default
condition: $parameters.protocol != "SSL"
value: 80
<!--NeedCopy-->
例 2：
parameters-conditions:
-
target: $parameters.port
action: set-default-value
value: if-then-else($parameters.protocol == "SSL", 443, 80)
<!--NeedCopy-->
ユーザーが SSL プロトコルを選択すると、デフォルトのポート値は443に設定されます。他のプロトコルでは、デフォルトのポート値は80に設定されます。例 1 と例 2 でも同じ結果が得られます。
‘セット必須’
アクションが実行されset-required、指定された条件が戻るTrueと 、ターゲットパラメータは構成パックを作成するための必須フィールドになります。
parameters-conditions:
-
target: $parameters.security-settings.cert-details
action: set-required
condition: $parameters.protocol in ["SSL", "SSL-BRIDGE"]
<!--NeedCopy-->
最初は、 security-settings パラメータに証明書の詳細は必要ない場合があります。ユーザーが SSL または SSLブリッジプロトコルを選択すると 、証明書の詳細が構成パックを作成するための必須フィールドになります。
‘許可された値を設定’
アクションがset-allowed-valuesであり、指定された条件がTrueを戻すと 、target パラメータがは指定された値のみを選択できるようにします。
例：
parameters-conditions:
-
target: $parameters.app-name
action: set-allowed-values
value:
- "SSL"
condition: $parameters.lb-virtual-port == 443
<!--NeedCopy-->
ユーザーがロードバランサー仮想ポートとして443を指定すると、アプリケーションの名前で SSL オプションのみが許可されます。
‘set-label ‘
アクションがset-labelであり、指定された条件がTrueを返すと、ターゲットパラメーターのラベルは指定されたテキストに変更されます。
例：
parameters-conditions:
-
target: $parameters.app-name
action: set-label
value: if-then-else($parameters.lb-service-type == "TCP", "TCPApp","UDPApp")
<!--NeedCopy-->
ユーザーがロードバランサープロトコルを TCPとして選択すると、アプリケーションのラベルが TCPAPPに変わります。ユーザーが別のオプションを選択すると、アプリケーションのラベルが UDPAppに変わります。
‘set-description’
アクションがset-descriptionであり、指定された条件がTrueを返すと、ターゲットパラメーターの説明は指定されたテキストに変更されます。このディスクリプションは、ターゲットパラメータのツールチップに表示されます。
例：
parameters-conditions:
-
target: $parameters.app-name
action: set-description
value: if-then-else($parameters.lb-service-type == "TCP", "Select a TCP application name","Select a UDP application name")
<!--NeedCopy-->
ユーザーがロードバランサープロトコルを TCPとして選択すると、アプリケーションのツールヒントに「」というテキストが表示されます Select a TCP application name。ユーザーが別のオプションを選択すると、アプリケーションの説明がSelect a UDP application nameを表示します。
「折りたたみペイン」または「展開ペイン」
アクションがcollapse-paneであり、指定された条件がTrueを戻すと 、ターゲットパラメータのペインが GUIで折りたたまれます。
アクションがexpand-paneであり、指定された条件がTrueを戻すと 、tターゲット パラメータのペインが GUIで展開されます。
例：
parameters-conditions:
-
target: $parameters.security-settings.cert-details
action: expand-pane
condition: $parameters.protocol in ["SSL", "SSL-BRIDGE"]
<!--NeedCopy-->
最初は、 security-settings パラメータに対して証明書の詳細ウィンドウが展開されないことがあります。ユーザーが SSL または SSLブリッジプロトコルを選択すると 、証明書の詳細ペインが GUI 上で展開されます。
‘set-pattern’
アクションがset-patternであり、指定された条件がTrueを返すと、ターゲットパラメーターフィールドが指定されたパターンに設定されます。
例：
parameters-conditions:
-
target: $parameters.app-name
action: set-pattern
value: "[a-z]+"
<!--NeedCopy-->
この例では、アプリケーション名には英小文字しか使用できません。
ネストされたパラメーター条件
StyleBook定義では、パラメーター条件内にパラメーター条件を指定できます。これらの条件はネストされたパラメーター条件と呼ばれ、repeat 構文を使用してこれらの条件を定義します。ネストされたパラメーター条件は、別のパラメーターのパラメーターにアクションを適用する場合に便利です。
例：
parameters-conditions:
-
repeat: $parameters.lbvservers
repeat-item: lbvserver
parameters-conditions:
-
target: $lbvserver.port
action: set-allowed-values
condition: $lbvserver.protocol == "HTTPS"
value: $parameters.ssl-ports
<!--NeedCopy-->
この例では、ユーザーが負荷分散仮想サーバーに HTTPS プロトコルを選択すると、ポート値が動的に入力されます。また、リスト内の各負荷分散仮想サーバーに適用されます。