样书配置

创建和使用自定义样书

您可以为部署编写自己的样书,将其导入 NetScaler ADM,然后创建配置对象。您也可以使用 API 从您的样书创建配置。

本文档包含以下信息:

开始之前的准备工作

开始创建样书之前,请确保您了解以下内容:

样书文件使用 YAML 格式。有关 YAML 格式的信息,请参阅 YAML 语法

下面是创建样书时必须了解的 YAML 准则列表:

  • YAML 区分大小写。
  • YAML 要求使用正确的行首缩进。
  • 使用 <spacebar> 密钥创建正确的缩进。不要使用 <tab> 密钥。在将样书导入 MA 服务时,使用 <tab> 密钥会导致编译错误。
  • 请勿在字符串两边加引号。仅当字符串具有标点符号(破折号、冒号等)时,才将字符串包含在引号内。如果您想将一个数字解释为字符串,可以在引号内加上数字,或者使用样书的 str() 内置函数。
  • YES/Yes/yes/Y/y/NO/no/No/n/N、ON/On/on/OFF/Off/off 和 TRUE/true/truthy/FALSE/False/false/falsely 等字面值被视为布尔值,分别等同于 true 和 false。要将它们解释为字符串,请在其两边加引号。例如:

    • “YES”
    • “No”
    • “True”
    • “False” 等等。

注意

在将样书文件导入 NetScaler ADM 之前,建议您验证您的文件是否符合 YAML 格式。Citrix 建议您使用样本中的内置 YAML 验证程序来验证和导入 YAML 内容。

有关更多信息,请参阅 NITRO API 文档

样本解析

编写样书要求您了解样书的语法、句法和结构。典型的样书包含以下部分:

  • 标题:本节允许您定义样书的标识并描述其用途。这是必需的部分。
  • 导入样书:此部分用于声明要在当前样书中引用哪个其他样书。编写样书需要导入 NetScaler NITRO 配置样书或其他样书。这是必需的部分。
  • 参数:此部分用于定义样书中所需的参数以创建配置。它描述样本接收的输入。这是可选部分。
  • 组件:此部分允许您定义样书为特定配置创建的实体(配置对象)。此部分被视为样书的核心。组件通常使用 parameters 部分中提供的输入来改写样书生成的配置。这是可选部分。
    样书可以包含 parameters 部分或 components 部分,也可以同时包含两者。如果要定义其他样书可以使用的一组参数,可以使用仅含 parameters 部分的样书。这有利于在一组样书之间重用参数组。如果要在样书中指定属性值,而不是定义参数来接收用户输入,可以使用仅含 components 部分的样书。
  • 输出:参数部分定义样书的输入时,此可选部分定义其输出。在此可选输出部分,可以指定要向基于此样书创建配置的用户和导入此样书的其他样书呈现的组件。之后,用户和导入样书可以引用呈现的组件的属性。
  • 操作:样书可能包含一个可选部分,用于在作为样书一部分的任何虚拟服务器上在 NetScaler ADM 中启用 Analytics。

下图显示了一个简单的样本概况。

样书大纲

以下示例帮助您了解样本的语法和结构,以及如何编写复杂程度不断增加的样本。

创建和使用自定义样书