Citrix Application Delivery Management 服务

组件

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

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

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

属性 说明
名称 组件的名称。可以指定字母数字名称。名称必须以字母开头,可以包括其他字母、数字、连字符 (-) 或下划线 (_)。
说明 样本中此组件的角色的说明。
类型 类型确定此组件提供哪些属性。组件有两种类型: 内置类型:此类型由系统提供,您不必定义它,例如,NITRO 实体类型 “lbvserver” 或 “服务组”。“ 当组件具有内置类型属性时,它会在 Citrix ADC 上创建该类型的配置对象。例如,如果某个组件引用内置类型 “lbvserver”,则此组件将在作为配置目标的 Citrix ADC 实例上创建一个负载平衡虚拟服务器。复合类型:此类型指您创建并导入到 Citrix Application Delivery Management (ADM) 的现有样本。当组件具有复合类型属性时,它会在作为配置目标的 Citrix ADC 实例上创建所有配置对象(在引用样本中指定)。这让您可以组合多个样本,其中每个样本创建最终配置的一部分。有关复合样本的更多信息,请参阅创建复合样本
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

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

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

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

注意

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

组件