Configuration de StyleBook

Composants

La construction Components d’un StyleBook est considérée comme la section la plus importante du StyleBook. Dans cette section, vous définissez les objets de configuration qui doivent être créés. À l’aide de cette construction, vous pouvez créer un ou plusieurs objets de configuration du même type.

La construction des composants peut utiliser l’entrée fournie dans la section des paramètres pour adapter la configuration générée par le StyleBook. Cette section est facultative, bien que la plupart des StyleBooks aient une section sur les composants.

Le tableau suivant décrit les principaux attributs d’un composant.

Attribut Description
name Le nom du composant. Vous pouvez spécifier un nom alphanumérique. Le nom doit commencer par un alphabet et peut inclure des alphabets supplémentaires, des chiffres, un trait d’union (-) ou un trait de soulignement (_).
description Description du rôle de ce composant dans le StyleBook.
type Le type détermine les propriétés que ce composant fournit. Les composants ont deux types de types : Type intégré : Ce type est fourni par le système et vous n’avez pas à le définir, par exemple, les types d’entités NITRO lbvserver ou servicegroup. Lorsqu’un composant dispose d’un attribut type intégré, il crée un objet de configuration de ce type sur l’Citrix ADC. Par exemple, si un composant fait référence au type intégré lbvserver, ce composant crée un serveur virtuel d’équilibrage de charge sur l’instance Citrix ADC qui est la cible de la configuration. Type composite : ce type fait référence à un StyleBook existant que vous avez créé et importé dans Citrix ADM. Lorsqu’un composant possède un attribut de type composite, il crée tous les objets de configuration, qui sont spécifiés dans le StyleBook référencé, sur l’instance Citrix ADC qui est la cible de la configuration. Cela vous permet de combiner plusieurs StyleBooks où chaque StyleBook crée une partie de la configuration finale. Pour plus d’informations sur les StyleBooks composites, voir Créer un StyleBook composite.
meta-properties Les méta-propriétés définissent les actions à effectuer sur les objets ADC. Elle peut prendre des valeurs statiques ou dynamiques en tant qu’action de méta-propriété valide. Lorsque vous spécifiez des expressions pour une méta-propriété, celle-ci applique de manière dynamique les actions de méta-propriété valides pour les objets ADC. Cet attribut peut être utilisé dans un StyleBook lorsque vous souhaitez effectuer des opérations non CRUD sur des objets ADC. Pour plus d’informations, voir Création d’un StyleBook pour effectuer des opérations non CRUD.
properties Les sous-attributs qui peuvent être utilisés pour un attribut de type de composant. Les propriétés valides pour un composant sont dictées par son type. Pour un type intégré, il s’agit des propriétés ou attributs de l’objet NITRO correspondant. Pour un composant dont le type est un autre StyleBook, c’est-à-dire un type composite, les propriétés correspondent aux paramètres définis dans ce StyleBook.

Exemple :


components:

   -

     name: my-lbvserver-comp

     type: ns::lbvserver

     properties:

        name: $parameters.name

        servicetype: HTTP

        ipv46: $parameters.ip

        port: 80

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

Dans cet exemple, vous avez défini un composant appelé my-lbvserver-comp. Ce composant est du type ns : :lbvserver (un type intégré), où « ns » est le préfixe qui fait référence à l’espace de noms netscaler.nitro.config et à la version 10.5 que vous avez spécifiés dans la section import-stylebooks, et lbvserver constitue une ressource NITRO dans cet espace de noms.

Les propriétés de cette section incluent quatre attributs obligatoires et un attribut facultatif (lbmethod) de la lbvserver ressource et vous permet de spécifier des valeurs pour ces attributs. Dans cet exemple, vous spécifiez des valeurs statiques pour servicetype et port tandis que le nom, ipv46 et les lbmethod propriétés obtiennent leurs valeurs à partir des paramètres d’entrée. Vous faites référence aux noms de paramètres définis dans la section des paramètres en utilisant la $parameters.\<name> notation, par exemple, $parameters.ip.

Pour en savoir plus sur toutes les ressources Citrix ADC NITRO disponibles et leurs attributs/propriétés, consultez la documentation de l’ API REST Citrix ADC NITRO .

Remarque

Vous devez utiliser des minuscules pour les noms d’attributs des types de ressources NITRO (les propriétés de ses composants). Sinon, l’importation d’un StyleBook échouera.

Composants

Dans cet article