参数条件
在样书定义中,参数定义样书用户为创建配置包而提供的输入。有时,您可能想要修改参数的行为,如下所示:
- 仅在满足条件时向用户显示某些参数。
- 允许一个参数的值依赖于另一个参数。
- 仅在特定条件下将参数设置为必填参数。
在这些情况下,请使用 parameters-conditions
部分定义参数条件。参数条件具有以下属性:
-
target
:指定要应用条件的参数。 -
action
:指定目标参数与条件匹配时要采取的操作。此功能支持以下操作: -
condition
:指定必须满足的条件。 -
value
:根据操作设置目标参数属性的值。
说明
目前无法对列表对象中的参数应用参数条件。
“显示”或“隐藏”
当操作为 show
且指定的条件返回 True
时,目标参数将显示在 GUI 上。
当操作为 hide
且指定的条件返回 True
时,目标参数将从 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
且指定的条件返回 True
时,目标参数的值将设置为默认值。
示例 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
时,target 参数将成为创建配置包的必填字段。
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 参数允许您仅选择指定的值。
示例 1:
parameters-conditions:
-
target: $parameters.app-name
action: set-allowed-values
value:
- "SSL"
condition: $parameters.lb-virtual-port == 443
<!--NeedCopy-->
当用户指定 443
为负载平衡器虚拟端口时,应用程序的名称仅允许 SSL 选项。
Example-2;
parameters:
-
name: root-certificates
label: "Root Certificates"
type: object[]
parameters:
-
name: certkey-name
label: "SSL Root CertKey Name"
type: string
required: true
-
name: im-certificates
label: "Intermediate Certificates"
type: object[]
parameters:
-
name: certkey-name
label: "Name of Intermediate CertKey"
type: string
required: true
-
name: link-options
label: "Link to Root or Intermediate CertKey?"
type: string
allowed-values:
- Root
- Intermediate
default: Root
required: true
-
name: link-certkey
label: "Linked to Root/Intermediate CertKey Name"
type: string
required: true
parameters-conditions:
-
repeat: $parameters.im-certificates
repeat-item: imcert
parameters-conditions:
-
target: $imcert.link-certkey
action: set-allowed-values
condition: $imcert.link-options == "Root"
value: $parameters.root-certificates[\*].certkey-name
-
target: $imcert.link-certkey
action: set-allowed-values
condition: $imcert.link-options == "Intermediate"
value: $parameters.im-certificates[\*].certkey-name
<!--NeedCopy-->
此示例是关于设置 SSL 证书的值。参数条件中的重复构造遍历所有中间证书 (im-certificates
) 并检查每个证书的 link-options
参数。
如果 link-options
参数匹配某个值,则 link-certkey
参数中允许的值将添加到相应的证书列表中。
例如,如果 link-options
参数为 Root
,则 link-certkey
参数中允许的值将添加到 root-certificate
列表中。
以下符号用于将证书添加到列表中:
-
对于根证书:
$parameters.root-certificates[*].certkey-name <!--NeedCopy-->
-
对于中间证书:
$parameters.im-certificates[*].certkey-name <!--NeedCopy-->
‘设置标签’
当操作为 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
且指定的条件返回 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
时,目标参数的窗格将在 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
且指定条件返回 True
时,目标参数字段将设置为指定的模式。
示例:
parameters-conditions:
-
target: $parameters.app-name
action: set-pattern
value: "[a-z]+"
<!--NeedCopy-->
在此示例中,应用程序的名称仅允许使用小写字母字符。
嵌套参数条件
在样书定义中,可以在参数条件中指定参数条件。这些条件被称为嵌套参数条件,并使用 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 协议时,将动态填充端口值。而且,它适用于列表中的每个负载平衡虚拟服务器。