Citrix Application Delivery Management 13.0

Paramètres

Cette section vous permet de définir tous les paramètres dont vous avez besoin dans votre StyleBook pour créer une configuration. Il décrit l’entrée que votre StyleBook prend. Bien qu’il s’agisse d’une section facultative, la plupart des StyleBooks peuvent en avoir besoin. Vous pouvez considérer la section Paramètres pour définir les questions auxquelles les utilisateurs doivent répondre lorsqu’ils utilisent le StyleBook pour créer une configuration sur une instance Citrix ADC.

Lorsque vous importez votre StyleBook dans Citrix ADM et que vous l’utilisez pour créer une configuration, l’interface graphique utilise cette section du StyleBook pour afficher un formulaire qui prend l’entrée pour les valeurs des paramètres que vous avez définis.

La section suivante décrit les attributs que vous devez spécifier pour chaque paramètre de cette section :

nom

Nom du paramètre que vous souhaitez définir. Vous pouvez spécifier un nom alphanumérique.

Le nom doit commencer par un alphabet et peut inclure des alphabets supplémentaires, des nombres, un trait d’union (-) ou un trait de soulignement (_).

Notez que lors de l’écriture d’un StyleBook, vous pouvez utiliser cet attribut « name » pour faire référence au paramètre dans d’autres sections en utilisant la notation $parameters.<name>.

Obligatoire ? Oui

étiquette

Chaîne affichée dans l’interface graphique d’ADM en tant que nom de ce paramètre.

Obligatoire ? Non

description

Chaîne d’aide qui décrit à quoi sert le paramètre. L’interface graphique ADM affiche ce texte lorsque l’utilisateur clique sur l’icône d’aide de ce paramètre.

Obligatoire ? Non

type

Type de valeur que ces paramètres peuvent prendre. Les paramètres peuvent être de l’un des types intégrés suivants :

  • string : Un tableau de caractères. Si aucune longueur n’est spécifiée, la valeur de la chaîne peut prendre n’importe quel nombre de caractères. Toutefois, vous pouvez limiter la longueur d’un type de chaîne en utilisant les attributs min-length et max-length.

  • nombre : nombre entier. Vous pouvez spécifier le nombre minimum et maximum que ce type peut prendre en utilisant les attributs min-value et max-value.

  • boolean : peut être vrai ou faux. Notez également que tous les littéraux sont considérés par YAML comme des booléens (par exemple, Oui ou Non).

  • ipaddress : chaîne qui représente une adresse IPv4 ou IPv6 valide.

  • tcp-port : nombre compris entre 0 et 65535 qui représente un port TCP ou UDP.

  • password : Représente une valeur de chaîne opaque/secrète. Lorsque l’interface graphique Citrix ADM affiche une valeur pour ce paramètre, elle s’affiche sous la forme d’astérisques (*****).

  • certfile : Représente un fichier de certificat. Cela vous permet de télécharger les fichiers directement à partir de votre système local lorsque vous créez une configuration StyleBook à l’aide de l’interface graphique d’ADM. Le fichier de certificat téléchargé est stocké dans le répertoire /var/mps/tenants/<tenant_path>/ns_ssl_certs d’ADM.

    Le fichier de certificat sera ajouté à la liste des certificats gérés par ADM.

  • keyfile : Représente un fichier de clé de certificat. Cela vous permet de télécharger le fichier directement à partir de votre système local lorsque vous créez une configuration StyleBook à l’aide de l’interface graphique Citrix ADM. Le fichier de certificat téléchargé est stocké dans le répertoire /var/mps/tenants/<tenant_path>/ns_ssl_keys de Citrix ADM.

    Le fichier de clé de certificat est ajouté à la liste des clés de certificat gérées par Citrix ADM.

  • file : Représente un fichier.

  • objet : ce type est utilisé lorsque vous souhaitez regrouper plusieurs paramètres associés sous un élément parent. Vous devez spécifier le paramètre parent le type comme « objet ». Un paramètre de type « objet » peut avoir une section « paramètres » imbriquée pour décrire les paramètres qu’il contient.

  • un autre StyleBook : lorsque vous utilisez ce type de paramètre, ce paramètre s’attend à ce que sa valeur soit sous la forme des paramètres définis dans le StyleBook indiquant son type.

Un paramètre peut également avoir un type qui est une liste de l’un des types énumérés ci-dessus, en ajoutant « [] » à la fin du type. Par exemple, si l’attribut type est string [], ce paramètre prend une liste de chaînes en entrée. Vous pouvez fournir une, deux ou plusieurs chaînes pour ce paramètre lors de la création d’une configuration à partir de ce StyleBook.

Obligatoire ? Oui

clé

Spécifiez true ou false pour indiquer si ce paramètre est un paramètre clé pour le StyleBook.

Un StyleBook ne peut avoir qu’un seul paramètre défini comme paramètre « key ».

Lorsque vous créez des configurations différentes à partir du même StyleBook (sur les mêmes instances Citrix ADC ou différentes), chaque configuration a une valeur différente/unique pour ce paramètre.

La valeur par défaut est false.

Obligatoire ? Non

requis

Spécifiez true ou false pour indiquer si un paramètre est obligatoire ou facultatif. S’il est défini sur true, le paramètre est obligatoire. Un utilisateur doit fournir une valeur pour un paramètre obligatoire pour créer une configuration, sauf si une valeur par défaut est définie.

L’interface graphique Citrix ADM force l’utilisateur à fournir une valeur valide pour ce paramètre.

La valeur par défaut est false.

Obligatoire ? Non

Remarque

Si un paramètre a type: object et required: false, les sous-paramètres de ce paramètre ne sont pas évalués.

Si vous voulez que la valeur par défaut des sous-paramètres prenne effet, définissez required: true pour le paramètre principal comme suit :

    type: object
    required: true
    gui:
      collapse_pane: true
<!--NeedCopy-->

L’attribut collapse_pane affiche l’objet et ses sous-paramètres réduits dans l’interface utilisateur, sauf si l’utilisateur développe le volet.

valeurs autorisées

Utilisez cet attribut pour définir une liste de valeurs valides pour un paramètre, lorsque le type est défini sur « string. »

Lors de la création d’une configuration à partir de l’interface graphique Citrix ADM, l’utilisateur est invité à sélectionner une valeur de paramètre dans cette liste.

Exemple 1 :

 -
   name: ipaddress
   type: string
   allowed-values:
     -  SOURCEIP
     -  DEST IP
     -  NONE
<!--NeedCopy-->

Exemple 2 :

 -
   name: TCP Port
   type: tcp-port
   allowed-values:
     -  80
     -  81
     -  8080
<!--NeedCopy-->

Exemple 3 :

(liste des ports tcp-, où chaque élément de la liste ne peut avoir que des valeurs spécifiées dans des valeurs autorisées)

  -
    name: tcpports
    type: tcp-port[]
    allowed-values:
      -  80
      -  81
      -  8080
      -  8081
<!--NeedCopy-->

Obligatoire ? Non

Par défaut

Utilisez cet attribut pour affecter une valeur par défaut à un paramètre facultatif. Lors de la création d’une configuration, si un utilisateur ne spécifie pas de valeur, la valeur par défaut est utilisée.

Lors de la création de la configuration à partir de l’interface graphique Citrix ADM, si un utilisateur ne fournit pas de valeur pour un paramètre qui n’a pas de valeur par défaut, aucune valeur n’est définie pour ce paramètre.

Exemple 1 :

  -
    name: timeout
    type: number
    default: 20
<!--NeedCopy-->

Exemple 2 :

(où, la valeur par défaut du paramètre est une liste de valeurs) :

  -
    name: protocols
    type: string[]
    default:
      - TCP
      - UDP
      - IP
<!--NeedCopy-->

Exemple 3 :

  -
    name: timeout
    type: number
    default: 20
<!--NeedCopy-->

Exemple 4 :

  -
    name: tcpport
    type: tcp-port
    default: 20
<!--NeedCopy-->

Obligatoire ? Non

modèle

Utilisez cet attribut pour définir un motif (expression régulière) pour les valeurs valides de ce paramètre, lorsque le type du paramètre est « string. »

Exemple :

  -
    name: appname
    type: string
    pattern: "[a-z]+"
<!--NeedCopy-->

Obligatoire ? Non

min-value

Utilisez cet attribut pour définir la valeur minimale des paramètres de type « number » ou « tcp-port ».

Exemple :

  -
    name: audio-port
    type: tcp-port
    min-value: 5000
<!--NeedCopy-->

La valeur min. des nombres peut être négative, mais la valeur min. pour tcp-port ne doit pas être négative.

Obligatoire ? Non

max-value

Utilisez cet attribut pour définir la valeur maximale des paramètres de type « number » ou « tcp-port ».

La valeur maximale doit être supérieure à la valeur minimale, si elle est définie.

Exemple :

  -
    name: audio-port
    type: tcp-port
    min-value: 5000
    max-value: 15000
<!--NeedCopy-->

Obligatoire ? Non

min-length

Utilisez cet attribut pour définir la longueur minimale des valeurs acceptées pour un paramètre de type « string. »

La longueur minimale des caractères définis comme valeurs doit être supérieure ou égale à zéro.

Exemple :

  -
    name: appname
    type: string
    min-length: 3
<!--NeedCopy-->

Obligatoire ? Non

max-length

Utilisez cet attribut pour définir la longueur maximale des valeurs acceptées pour un paramètre de type « string. »

La longueur maximale des valeurs doit être supérieure ou égale à la longueur des caractères définis en min-longueur.

Exemple :

  -
    name: appname
    type: string
    max-length: 64
<!--NeedCopy-->

Obligatoire ? Non

min-items

Utilisez cet attribut pour définir le nombre minimum d’éléments dans un paramètre qui est une liste.

Le nombre minimum d’éléments doit être supérieur ou égal à zéro.

Exemple :

  -
    name: server-ips
    type: ipaddress[]
    min-items: 2
<!--NeedCopy-->

Obligatoire ? Non

max-items

Utilisez cet attribut pour définir le nombre maximal d’éléments dans un paramètre qui est une liste.

Le nombre maximal d’éléments doit être supérieur au nombre minimal d’éléments s’il est défini.

Exemple :

  -
    name: server-ips
    type: ipaddress[]
    min-items: 2
    max-items: 250
<!--NeedCopy-->

Obligatoire ? Non

GUI

Utilisez cet attribut pour personnaliser la mise en page du paramètre de type « object » dans l’interface graphique Citrix ADM.

Obligatoire ? Non

colonnes

Ceci est un sous-attribut de l’attribut gui. Cet attribut est utilisé pour les paramètres de la liste des types d’objets. Ces paramètres s’affichent dans l’interface graphique sous forme de tableau. Chaque ligne représente un objet dans la liste et les colonnes représentent les clés d’objet. Utilisez cette option pour définir le nombre de colonnes à afficher dans l’interface graphique Citrix ADM.

Par défaut, toutes les clés d’objet de type string sont affichées.

Obligatoire ? Non

modifiable

Ceci est un sous-attribut de l’attribut gui. Utilisez cette option pour spécifier si le paramètre peut être mis à jour après la création de la configuration.

Si la valeur est définie sur false, le champ de paramètre est grisé lorsque vous mettez à jour la configuration.

Obligatoire ? Non

collapse_pane

Ceci est un sous-attribut de l’attribut gui. Utilisez cette option pour spécifier si le volet définissant la disposition de ce paramètre d’objet est pliable.

Si la valeur est définie sur true, l’utilisateur peut développer ou réduire les paramètres enfants sous ce paramètre parent.

Exemple :

gui:
 collapse_pane: true
 columns: 2
 updatable: false
<!--NeedCopy-->

Exemple d’une section complète des paramètres :


parameters:
   -
      name: name
      label: Name
      description: Name of the application
      type: string
      required: true
       -
         name: ip
         label: IP Address
         description: The virtual IP address used for this application
         type: ipaddress
         required: true
      -
         name: svc-servers
         label: Servers
         type: object[]
         required: true
         parameters:
            -
               name: svc-ip
               label: Server IP
               description: The IP address of the server
               type: ipaddress
               required: true
                -
                  name: svc-port
                  label: Server Port
                  description: The TCP port of the server
                  type: tcp-port
                  default: 80
      -
          name: lb-alg
          label: LoadBalancing Algorithm
          type: string
          allowed-values:
            - ROUNDROBIN
            - LEASTCONNECTION
          default: ROUNDROBIN
      -
          name: enable-healthcheck
          label: Enable HealthCheck?
          type: boolean
          default: true
<!--NeedCopy-->

Voici un exemple qui définit tous les attributs d’une liste et les valeurs expliquées dans les sections précédentes :

  -
    name: features-list
    type: string[]
    min-length: 1
    max-length: 3
    min-items: 1
    max-items: 3
    pattern: "[A-Z]+"
    allowed-values:
     - SP
     - LB
     - CS
    default:
     - LB
<!--NeedCopy-->