创建和使用自定义样本

您可以为部署编写自己的样本,将其导入 Citrix Application Delivery Management (ADM),然后创建配置对象。还可以使用 API 根据您的样本创建配置。

本文档包含以下信息:

准备工作

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

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

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

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

    • “YES”
    • “不”
    • “真实”
    • “假” 等。

注意

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

配置样本时,您只能使用支持创建删除操作的 Nitro 配置资源(POST 和 DELETE HTTP 方法)。有关详细信息,请参阅Nitro API 文档

样本解析

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

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

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

本地化后的图片

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

创建和使用自定义样本