样书配置

组件

样书中的 components 构造被视为样书中最重要的部分。在此部分,定义必须要创建的配置对象。通过使用此构造,可以构建相同类型的一个或多个配置对象。

components 构造使用 parameters 部分中提供的输入来改写样书生成的配置。这是一个可选部分,尽管大多数样书都有一个 components 部分。

下表介绍了组件的主要属性。

属性 说明
name 组件的名称。可以指定字母数字名称。名称必须以字母开头,可以包含额外的字母、数字、连字符 (-) 或下划线 (_)。
description 样书中此组件的角色的说明。
type 类型确定此组件提供哪些属性。组件有两种类型: 内置类型:此类型由系统提供,您无需定义它,例如 NITRO 实体类型 lbvserverservicegroup。当组件具有内置类型属性时,它会在 Citrix ADC 上创建该类型的配置对象。例如,如果组件引用内置类型 lbvserver,则此组件将在作为配置目标的 Citrix ADC 实例上创建负载平衡虚拟服务器。复合类型:此类型指您创建并导入 Citrix ADM 的现有样书。当组件具有复合类型属性时,它会在作为配置目标的 Citrix ADC 实例上创建所有配置对象,这些对象在引用的样书中指定。这让您可以组合多个样书,其中每个样书创建最终配置的一部分。有关复合样书的详细信息,请参阅创建复合样书
meta-properties 元属性定义了要对 ADC 对象采取的操作。它可以将静态或动态值作为有效的元属性操作。当您为元属性指定表达式时,它会动态地对 ADC 对象应用有效的元属性操作。当您想要对 ADC 对象执行非 CRUD 操作时,可以在样书中使用此属性。有关更多信息,请参见 创建样书以执行非 CRUD 操作
properties 可以用于组件类型属性的子属性。组件的有效属性由其类型决定。对于内置类型,这些是对应 NITRO 对象的属性或属性。对于其类型是另一个样本的组件(即复合类型),属性对应于该样本中定义的参数。

示例


components:

   -

     name: my-lbvserver-comp

     type: ns::lbvserver

     properties:

        name: $parameters.name

        servicetype: HTTP

        ipv46: $parameters.ip

        port: 80

        lbmethod: $parameters.lb-alg
<!--NeedCopy-->

在本例中,您定义了一个名为的组件 my-lbvserver-comp。此组件的类型为 ns:: lbvserver(一种内置类型),其中“ns”是指您在导入样书部分中指定的命名空间 netscaler.nitro.config 和版本 10.5 的前缀,并且 lbvserver 是该命名空间中的 NITRO 资源。

本节中的属性包括 lbvserver 资源的四个必需属性和一个可选属性 (lbmethod),允许您为这些属性指定值。在此示例中,您正在为 servicetype 和 port 指定静态值,而名称 ipv46 和 lbmethod 属性则从输入参数中获取它们的值。您可以使用 $parameters.\<name> 表示法来引用参数部分中定义的参数名称,例如 $parameters.ip。

要了解有关所有可用的 Citrix ADC NITRO 资源及其属性/属性的更多信息,请参阅 Citrix ADC NITRO REST API 文档。

注意

NITRO 资源类型的属性名称(其组件属性)必须使用小写。否则,StyleBook 导入将失败。

组件

在本文中