创建和使用自定义StyleBooks
您可以为您的部署编写自己的StyleBook,将其导入Citrix应用程序交付管理(ADM),并创建配置对象。还可以使用API从StyleBooks创建配置。
本文档包括以下内容:
在你开始之前
在你开始创建StyleBooks之前,确保你有以下知识:
硝基API。有关更多信息,请参见硝基API文档.
YAML
StyleBook文件使用YAML格式。有关YAML格式的信息,请参见YAML的语法.
以下是创建StyleBooks时必须注意的YAML指南列表:
- YAML区分大小写。
- YAML需要适当的压痕
- 使用
<空格键>
键创建适当的缩进。不要使用<选项卡>
关键。使用<选项卡>
在将StyleBook导入到MA Service时产生编译错误。 - 不要在引号内使用字符串。只有当字符串包含标点符号(破折号、冒号等)时,才将字符串包含在引号中。如果想将数字解释为字符串,可以在引号中包含该数字,或者使用StyleBooks的str()内置函数。
像YES/ YES/ YES/Y /Y/ NO/ NO/ NO/n /n, ON/ ON/ ON/ OFF/ OFF和TRUE/ TRUE/ TRUE/ FALSE/ FALSE/ FALSE这样的文字被认为是布尔值,分别等于TRUE和FALSE。要将它们解释为字符串,请将它们包含在引号中。例如:
- “是的”
- “不”
- “真正的”
- “错误”等等。
请注意
在将StyleBook文件导入Citrix ADM之前,建议您验证您的文件是否符合YAML格式。Citrix建议您在StyleBooks中使用内置的YAML验证器来验证和导入YAML内容。
在配置StyleBooks时,您只能使用NITRO Configuration资源支持创建和删除操作(POST和DELETE HTTP方法)。有关更多信息,请参见硝基api文档.
体裁书的解剖
编写StyleBooks需要你理解StyleBooks的语法、语法和结构。典型的StyleBook有以下几个部分:
- 头:本节允许您定义StyleBook的标识并描述它的功能。这是必修课。
- 导入样本:这一节允许您声明您想从当前的StyleBook中引用哪个其他的StyleBook。要编写StyleBook,需要导入Citrix ADC NITRO配置StyleBooks或其他StyleBooks。这是必修课。
- 参数:本节允许您在StyleBook中定义创建配置所需的参数。它描述了StyleBook接受的输入。这是可选的部分。
- 组件:本节允许您定义StyleBook为特定配置创建的实体(配置对象)。这一部分被认为是StyleBook的核心。组件通常使用parameters部分中提供的输入来调整StyleBook生成的配置。这是可选的部分。
StyleBook可以有一个参数部分,或者一个组件部分,或者两者都有。只有参数部分的StyleBook对于定义可被其他StyleBooks使用的参数列表很有用。这促进了参数组跨一组StyleBooks的可重用性。当您希望在StyleBook中指定属性的值,而不是定义参数以接受用户输入时,可以使用只有组件部分的StyleBook。 - 输出当parameters部分定义StyleBook的输入时,这个可选部分定义它的输出。在此可选输出部分中,您可以指定希望向从这个StyleBook创建配置的用户公开的组件,以及向导入这个StyleBook的其他StyleBooks公开的组件。然后,用户和导入StyleBooks就可以引用公开组件的属性。
- 操作: StyleBook可能包含一个可选的部分,用于在StyleBook的任何虚拟服务器上启用Citrix ADM中的分析。
下图显示了StyleBook的简单概要。
下面的示例帮助您了解StyleBook的语法和结构,以及如何编写越来越复杂的StyleBooks。
创建和使用自定义StyleBooks
复制!
失败了!