参数
在此部分可以定义样本中用于创建配置所需的所有参数。它描述样本接收的输入。尽管此部分是可选的，但大多数样书可能需要一个。您可以考虑参数部分为使用样书在Citrix ADC实例上创建配置的用户定义字段。
将样书导入Citrix ADM并使用它创建配置时，GUI使用样书的这一部分来显示表单。此表单接受定义的参数值的输入。
以下部分介绍了需要为本节中的每个参数指定的属性：
“名字”
要定义的参数的名称。可以指定字母数字名称。
名称必须以字母表开头，并且可以包含更多的字母、数字、连字符 (-) 或下划线 (_)。
在编写样书时，您可以使用此“name”属性通过使用表示法$参数来引用其他部分中的参数。<名称>。
强制性？是
“标签”
在adm GUI中显示为此参数的名称的字符串。
强制性？否
“描述”
说明参数用途的帮助字符串。当用户单击此参数的帮助图标时，adm GUI将显示此文本。
强制性？否
“类型”
这些参数可以接收的值类型。参数可以是以 下内置类型之一：
字符串:字符数组。如果未指定长度，则字符串值可以接收任何数量的字符。但是，可以使用 min-length 和 max-length 属性限制字符串类型的长度。
数量：一个整数。可以使用最小值和最大值属性指定此类型可以接收的最小数和最大数。布尔：可以是真的也可以是假的。Yaml将所有文字视为布尔值(例如，是或否)。ipaddress:表示有效的IPv4或IPv6地址的字符串。tcp端口:介于0到65535之间的数字，表示TCP或udp端口。密码：表示不透明/密码字符串值。当adm GUI显示此参数的值时，它将显示为星号(*****)。certfile：表示证书文件。使用adm GUI创建样书配置时，此值允许您直接从本地系统上传文件。上传的证书文件存储在adm的/var/mps/tenants/ \ < tenant_path > / ns_ssl_certs目录中。证书文件将添加到adm管理的证书列表中。
密钥文件：表示证书密钥文件。使用adm GUI创建样书配置时，此值允许您直接从本地系统上传文件。上传的证书文件存储在adm的/var/mps/tenants/ \ < tenant_path > / ns_ssl_keys目录中。证书密钥文件将添加到adm管理的证书密钥列表中。
文件：代表一个文件。对象：当您想要将多个相关参数分组到父元素下时，将使用此类型。将类型的父参数指定为“对象”。类型为"对象"的参数可以有嵌套的"参数"部分以描述其包含的参数。另一个样本：当您使用此类型的参数时，此参数期望其值以表示其类型的样书中定义的参数的形式。
参数也可以包含具有类型列表的类型。为此，请在文字末尾添加［］。例如，如果类型属性为string []，则此参数将字符串列表作为输入。可以在使用此样书创建配置时为此参数提供一个、两个或多个字符串。
强制性？是
“网络”
对于类型:ipaddress，您可以指定从adm ipam网络自动分配IP地址的网络属性。
创建样书配置时，adm会从网络属性中自动分配IP地址地址。
示例:
的名字：虚拟ip标签：＂负载平衡器知识产权地址”类型：ipaddress网络：＂network-1”要求：真正的<！--NeedCopy-->在此示例中，虚拟ip字段自动分配来自network-1的IP地址地址。删除配置后，ip地址将释放回网络。
动态分配的
动态分配属性将添加到类型:ipaddress的参数定义中。使用此属性动态列出adm ipam网络。此属性可以采用真正的或假作为输入。对于类型:ipaddress，指定动态分配:真属性以动态列出adm中的adm ipam网络。在配置包创建窗体中，您可以执行以下操作：
从列表中选择所需的ipam网络。
指定要从所选ipam网络分配的IP地址。
如果未指定IP地址，adm将自动分配来自所选ipam网络的IP地址。
示例：
-的名字：虚拟ip标签：＂负载平衡器知识产权地址”类型：ipaddress动态分配：真正的要求：真正的<！--NeedCopy-->在此示例中，虚拟ip字段列出了adm中的adm ipam网络。从列表中选择一个网络以从网络中自动分配IP地址地址。删除配置后，ip地址将释放回网络。
“关键”
指定真或假指示此参数是否是样本的主要参数。
样本只能有一个定义为“key”参数的参数。
当您从同一样书(在相同或不同的ADC实例上)创建不同的配置时,每个配置都有此参数的不同/唯一值。
默认值为false。
强制性？否
“要求”
指定真或假指示参数是必需的还是可选的。如果设置为true，则该参数是必需的，用户在创建配置时必须为此参数提供值。
行政GUI强制用户为此参数提供有效值。
默认值为false。
强制性？否
允许的值的
类型设置为" string "时，此属性用于定义参数的有效值列表。
从adm GUI创建配置时，系统会提示用户从此列表中选择参数值。
注意
如果要将列表值显示为单选选项，请设置 [
布局(#layout)属性。
示例 1：
-的名字：ipaddress类型：字符串允许的值：-SOURCEIP-IP不在座位上-没有一个<！--NeedCopy-->示例 2：
-的名字：TCP端口类型：tcp端口允许的值：-80-81-8080<！--NeedCopy-->示例 3：
tcp端口的列表，其中列表的每个元素只能在允许的值中指定的值。
-的名字：tcpport类型：tcp端口[]允许的值：-80-81-8080-8081<！--NeedCopy-->强制性？否
“默认”
此属性用于为可选参数指定默认值。当用户在未指定值的情况下创建配置时，将使用默认值。
如果满足以下条件，则参数不具任何值：
该参数没有默认值。
用户没有为参数提供值。
示例 1：
-的名字：超时类型：数量默认的：20.<！--NeedCopy-->示例 2：
要列出参数的默认值，请执行以下操作：
-的名字：协议类型：string []默认的：-TCP-UDP-知识产权<！--NeedCopy-->示例 3：
-的名字：超时类型：数量默认的：20.<！--NeedCopy-->示例 4：
-的名字：tcpport类型：tcp端口默认的：20.<！--NeedCopy-->强制性？否
“模式”
当参数的类型为”字符串时，使用此属性定义此参数的有效值的模式(正则表达式)。”
示例：
-的名字：浏览器名称类型：字符串模式：＂[a - z] +”<！--NeedCopy-->强制性？否
“最小值”
使用此属性可定义数量或tcp端口类型参数的最小值。
示例：
-的名字：音频接口类型：tcp端口最小值：5000<！--NeedCopy-->最小值数字可能是负数。但是，最小值（对于tcp端口）必须是正数。
强制性？否
的极大值
使用此属性可定义类型数量或tcp端口的参数的最大值。
确保最大值大于最小值（如果已定义）。
示例：
-的名字：音频接口类型：tcp端口最小值：5000极大值：15000<！--NeedCopy-->强制性？否
“min-length”
使用此属性可定义类型为" string "的参数所接受的值的最小长度。”
确保定义为值的字符的最小长度大于或等于零。
示例：
-的名字：浏览器名称类型：字符串min-length：3.<！--NeedCopy-->强制性？否
最大长度的
使用此属性可以定义类型为”字符串的参数所接受的值的最大长度。”
确保值的最大长度大于或等于在min-length中定义的字符的长度。
示例：
-的名字：浏览器名称类型：字符串最大长度：64<！--NeedCopy-->强制性？否
“min-items”
此属性用于定义列表参数中的最小项目数。
确保最小商品数量大于或等于零。
示例：
-的名字：服务器ip类型：ipaddress []min-items：2<！--NeedCopy-->强制性？否
“max-items”
使用此属性可定义作为 列表的参数中的最大项数。
确保最大商品数量大于最小商品数（如果已定义）。
示例：
-的名字：服务器ip类型：ipaddress []min-items：2max-items：250<！--NeedCopy-->强制性？否
“图形用户界面”
使用此属性可在adm GUI中自定义参数的布局。
强制性？否
“列”
此属性是gui属性的子属性。使用此属性可定义要在adm GUI中显示类型:object []参数的列数。
强制性？否
可更新的
此属性是gui属性的子属性。使用此属性可指定在创建配置后是否可以更新参数。仅在字符串、布尔值或数字等简单参数类型上设置此属性。
如果该值设置为假，则在更新配置时，参数字段将显示为灰色。
强制性？否
“collapse_pane”
此属性是gui属性的子属性。使用此属性可指定定义此对象参数布局的窗格是否可折叠。
如果值设置为正确，则用户可以展开或折叠此父参数下方的子参数。
示例：
gui：collapse_pane：真正的列：2<！--NeedCopy-->完整的参数部分示例:
参数：-的名字：的名字标签：的名字描述：应用程序名称类型：字符串要求：真正的-的名字：知识产权标签：IP地址描述：此应用程序使用的虚拟IP地址类型：ipaddress要求：真正的-的名字：svc-servers标签：服务器类型：对象[]要求：真正的参数：-的名字：svc-ip标签：服务器IP描述：服务器IP地址类型：ipaddress要求：真正的-的名字：svc-port标签：服务器端口描述：服务器的TCP端口类型：tcp端口默认的：80-的名字：lb-alg标签：loadbalance算法类型：字符串允许的值：-设置轮流捡取-LEASTCONNECTION默认的：设置轮流捡取-的名字：enable-healthcheck标签：使HealthCheck吗?类型：布尔默认的：真正的<！--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 “布局”
此属性是gui属性的子属性。使用此属性可以将列表值显示为单选按钮。在样书定义的参数部分中将布局属性设置为广播。它适用于具有 [允许的值(#allowed-values)属性的参数。创建配置包时，adm GUI将列表中的值显示为允许的值单选按钮。
示例:
-gui：布局：广播允许的值：-一个-两个-三个<！--NeedCopy-->“一”，“二”和“三”值在adm GUI中显示为单选按钮。
“dependent-parameters”
此属性是gui属性的子属性。它根据在另一个参数中指定的值动态控制参数的外观或其初始值在样书配置窗体中。
在控制参数在表单上的行为的源参数上指定此属性。您可以包含多个控制其他参数的条件。例如，源参数协议可以具有依赖参数证书，该参数仅在协议参数值为SSL时才会显示。
每个条件都可以具有以下属性：
目标参数：指定此条件适用的目标参数。
匹配的值：指定触发操作的源参数的值列表。
行动：对目标参数指定以下操作之一：
只读：该参数为只读。显示：如果参数被隐藏，则该参数将显示在窗体中。隐藏：该参数将从表单中删除。设定值：参数值被设置为值属性中指定的值。
价值：如果操作为
设定值，则为目标参数的值。
当用户输入与源参数上的指定值匹配时，目标参数的外观或值将根据指定的操作而发生变化。
示例：
-的名字：lb-virtual-port标签：＂负载平衡应用程序虚拟港”描述：＂TCP港口代表的负载平衡应用程序”类型：tcp端口gui：可更新的：假dependent-parameters：-匹配的值：-80目标参数：parameters.lb-service-type美元行动：设定值允许的值：-HTTP-TCP-UDP默认的：80<！--NeedCopy-->在此示例中，依赖参数在lb-virtual-port参数（源参数）下指定。
当源参数值设置为80时，lb-service-type参数将触发设定值操作。因此，允许用户选择以下选项之一：
- HTTP
- TCP
- UDP