Paramètres

Dernière publication : Oct 02, 2026
Cette section vous permet de définir tous les paramètres dont vous avez besoin dans votre StyleBook pour créer une configuration. Elle décrit l'entrée que votre StyleBook prend. Bien que cette section soit facultative, la plupart des StyleBooks pourraient en avoir besoin. Vous pouvez considérer la section des paramètres pour définir les champs pour les utilisateurs qui utilisent le StyleBook afin de créer une configuration sur une instance NetScaler.
Lorsque vous importez votre StyleBook dans NetScaler Console et l'utilisez pour créer une configuration, l'interface graphique utilise cette section du StyleBook pour afficher un formulaire. Ce formulaire prend une entrée pour les valeurs de paramètre définies.
La section suivante décrit les attributs que vous devez spécifier pour chaque paramètre de cette section :
Related information
Grammaire des StyleBooks

'nom'

Le nom du paramètre que vous souhaitez définir. Vous pouvez spécifier un nom alphanumérique.
Le nom doit commencer par une lettre et peut inclure d'autres lettres, des chiffres, un trait d'union (-) ou un trait de soulignement (_).
Lorsque vous écrivez 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'

Une chaîne de caractères qui est affichée dans l'interface graphique de NetScaler Console comme nom de ce paramètre.
Obligatoire ? Non

'Description'

Une chaîne d'aide qui décrit l'utilisation du paramètre. L'interface graphique de NetScaler Console affiche ce texte lorsque l'utilisateur clique sur l'icône d'aide de ce paramètre.
Obligatoire ? Non

'Type'

Le 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. Cependant, vous pouvez limiter la longueur d'un type de chaîne en utilisant les attributs min-length et max-length.
  • number: Un 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. YAML considère tous les littéraux comme des booléens (par exemple, Oui ou Non).
  • ipaddress: Une chaîne qui représente une adresse IPv4 ou IPv6 valide.
  • ipnetwork: Il a deux parties. La première partie est l'adresse IP et la seconde partie est le masque de sous-réseau.
    Réseau IP
    Le masque de sous-réseau se compose de la longueur du masque de sous-réseau (netmask-len) ou de l'adresse IP du masque de sous-réseau (netmask_ip). La longueur du masque de sous-réseau est un entier compris entre 0 et 32 et entre 0 et 128 pour une adresse IPv6. Elle est utilisée pour déterminer le nombre d'adresses IP dans un réseau.
    Lors de la création ou de la mise à jour d'un pack de configuration à partir de l'interface graphique de NetScaler Console, vous pouvez effectuer l'une des actions suivantes :
    • Activer la longueur du masque de sous-réseau et saisir l'adresse IP et la longueur du masque de sous-réseau
    • Désactiver la longueur du masque de sous-réseau et saisir l'adresse IP et l'adresse IP du masque de sous-réseau
  • tcp-port: Un 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 de NetScaler Console affiche une valeur pour ce paramètre, elle est affichée sous forme d'astérisques (*****).
  • certfile: Représente un fichier de certificat. Cette valeur vous permet de télécharger les fichiers directement depuis votre système local lorsque vous créez une configuration StyleBook à l'aide de l'interface graphique de NetScaler Console. Le fichier de certificat téléchargé est stocké dans le répertoire /var/mps/tenants/\<tenant_path>/ns_ssl_certs de NetScaler Console.
    Le fichier de certificat est ajouté à la liste des certificats gérés par NetScaler Console.
  • keyfile : Représente un fichier de clé de certificat. Cette valeur vous permet de télécharger le fichier directement depuis votre système local lorsque vous créez une configuration StyleBook à l'aide de l'interface graphique de NetScaler Console. Le fichier de certificat téléchargé est stocké dans le répertoire /var/mps/tenants/\<tenant_path>/ns_ssl_keys de NetScaler Console.
    Le fichier de clé de certificat est ajouté à la liste des clés de certificat gérées par NetScaler Console.
  • certkey : Ce type est utilisé pour sélectionner des certificats SSL à partir du magasin de certificats de NetScaler Console. Ce magasin répertorie les certificats SSL existants qui sont téléchargés sur votre serveur NetScaler Console. Ainsi, vous pouvez stocker les certificats SSL à un seul endroit, le magasin de certificats NetScaler Console, et les réutiliser chaque fois que nécessaire.
    Lors de la création d'un pack de configuration, un utilisateur peut ajouter ou sélectionner des certificats SSL à partir du magasin de certificats. L'utilisateur peut également sélectionner le même certificat pour plusieurs packs de configuration.
  • file : Représente un fichier.
  • object : Ce type est utilisé pour regrouper plusieurs paramètres connexes sous un élément parent. Spécifiez le type du paramètre parent comme "object". Un paramètre de type "object" peut avoir une section "parameters" imbriquée pour décrire les paramètres qu'il contient.
  • another 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 désignant son type.
Un paramètre peut également avoir une type qui est la liste des types. Pour ce faire, ajoutez [] à 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

'réseau'

Pour type: ipaddress, vous pouvez spécifier l'attribut network pour allouer automatiquement une adresse IP à partir d'un réseau IPAM de NetScaler Console.
NetScaler Console alloue automatiquement une adresse IP à partir de l'attribut network lorsque vous créez une configuration StyleBook.
Exemple :
name: virtual-ip
label: "Load Balancer IP Address"
type: ipaddress
network: "network-1"
required: true
Dans cet exemple, le champ virtual-ip alloue automatiquement une adresse IP à partir de network-1. L'adresse IP est libérée et renvoyée au réseau lorsque la configuration est supprimée.

'dynamic-allocation'

L'attribut dynamic-allocation est ajouté dans la définition du paramètre de type:ipaddress. Utilisez cet attribut pour lister dynamiquement les réseaux IPAM de NetScaler Console. Cet attribut peut prendre true ou false comme entrée. Pour type: ipaddress, spécifiez l'attribut dynamic-allocation: true pour lister dynamiquement les réseaux IPAM de NetScaler Console qui se trouvent dans NetScaler Console. Dans le formulaire de création de pack de configuration, vous pouvez effectuer les opérations suivantes :
  1. Sélectionnez le réseau IPAM requis dans la liste.
  2. Spécifiez une adresse IP que vous souhaitez allouer à partir du réseau IPAM sélectionné.
    Si aucune adresse IP n'est spécifiée, NetScaler Console alloue automatiquement une adresse IP à partir du réseau IPAM sélectionné.
Exemple :
-
  name: virtual-ip
  label: "Load Balancer IP Address"
  type: ipaddress
  dynamic-allocation: true
  required: true
Dans cet exemple, le champ virtual-ip liste les réseaux IPAM de NetScaler Console qui se trouvent dans NetScaler Console. Sélectionnez un réseau dans la liste pour allouer automatiquement une adresse IP à partir du réseau. L'adresse IP est libérée et renvoyée au réseau lorsque la configuration est supprimée.

'clé'

Spécifiez vrai ou faux pour indiquer si ce paramètre est un paramètre clé pour le StyleBook.
Un StyleBook peut avoir un ou plusieurs paramètres définis comme paramètre « clé ». La page Configuration > Packs de configuration affiche la valeur du paramètre en tant que Clé d'affichage.
Lorsque vous créez différents packs de configuration à partir du même StyleBook, chaque configuration peut avoir une valeur différente pour ce paramètre. Cette valeur apparaît comme clé d'affichage sur l'interface graphique. Avec cette clé, vous pouvez trier ou filtrer le pack de configuration.
Exemple :
parameters:
  - name: example-appname
    type: string
    label: Application Name
    required: true
    key: true
Lorsqu'un utilisateur de StyleBook crée un pack de configuration, la valeur du paramètre example-appname apparaît comme clé d'affichage. L'utilisateur de StyleBook peut utiliser cette clé pour identifier ce pack de configuration.
Remarque
La Clé de configuration d'un pack de configuration écrase l'attribut clé défini sur l'un de ses paramètres. Ainsi, si un utilisateur saisit une valeur pour la clé de configuration, cette valeur apparaît dans la colonne Clé d'affichage.
La valeur par défaut est false.
Obligatoire ? Non

« obligatoire »

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 et l'utilisateur doit fournir une valeur pour ce paramètre lors de la création de configurations.
L'interface graphique de NetScaler Console force l'utilisateur à fournir une valeur valide pour ce paramètre.
La valeur par défaut est false.
Obligatoire ? Non

'allowed-values'

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 de NetScaler Console, l'utilisateur est invité à sélectionner une valeur de paramètre dans cette liste. Cette liste est statique, l'utilisateur ne peut sélectionner qu'une valeur dans la liste. Si vous souhaitez autoriser l'utilisateur à ajouter des valeurs à la liste, utilisez l'attribut allow-new-values.
Remarque
Si vous souhaitez afficher les valeurs de la liste sous forme d'options radio, définissez l'attribut layout.
Exemple 1 :
-
      name: ipaddress
      type: string
      allowed-values:
            -  SOURCEIP
            -  DEST IP
            -  NONE
Exemple 2 :
-
      name: TCP Port
      type: tcp-port
      allowed-values:
            -  80
            -  81
            -  8080
Exemple 3 :
Liste de tcp-ports, où chaque élément de la liste ne peut avoir que les valeurs spécifiées dans allowed-values.
-
      name: tcpports
      type: tcp-port[]
      allowed-values:
            -  80
            -  81
            -  8080
            -  8081
Obligatoire ? Non

'allow-new-values'

Utilisez cet attribut pour ajouter une liste dynamique pour un paramètre. Lors de la création ou de la mise à jour d'une configuration à partir de l'interface graphique de NetScaler Console, l'utilisateur peut ajouter des valeurs à la liste.
Spécifiez true si vous souhaitez que l'utilisateur ajoute une valeur à la liste des paramètres. Vous pouvez utiliser les attributs allow-new-values et allowed-values en combinaison. Cette combinaison vous permet de définir une liste de valeurs suggérées pour un paramètre et d'accepter également de nouvelles valeurs.
-
      name: port
      type: tcp-port
      allowed-values:
            -  80
            -  81
            -  8080
      allow-new-values: true
Dans cet exemple, un utilisateur peut soit sélectionner parmi 80, 81, 8080, soit saisir une nouvelle valeur pour le paramètre port lors de la création ou de la mise à jour d'un pack de configuration.

'par défaut'

Utilisez cet attribut pour attribuer une valeur par défaut à un paramètre facultatif. Lorsqu'un utilisateur crée une configuration sans spécifier de valeur, la valeur par défaut est utilisée.
Le paramètre ne prend aucune valeur si les conditions suivantes sont remplies :
  • Le paramètre n'a pas de valeur par défaut.
  • Un utilisateur ne fournit pas de valeur pour le paramètre.
Exemple 1 :
-
      name: timeout
      type: number
      default: 20
Exemple 2 :
Pour lister les valeurs par défaut du paramètre :
-
      name: protocols
      type: string[]
      default:
            -  TCP
            -  UDP
            -  IP
Exemple 3 :
-
      name: timeout
      type: number
      default: 20
Exemple 4:
-
      name: tcpport
      type: tcp-port
      default: 20
Obligatoire ? Non

'modèle'

Utilisez cet attribut pour définir un modèle (expression régulière) pour les valeurs valides de ce paramètre, lorsque le type du paramètre est « chaîne de caractères ».
Exemple:
-
      name: appname
      type: string
      pattern: "[a-z]+"
Obligatoire ? Non

'min-value'

Utilisez cet attribut pour définir la valeur minimale pour les paramètres de type number ou tcp-port.
Exemple:
-
      name: audio-port
      type: tcp-port
      min-value: 5000
Le min-value des nombres peut être négatif. Cependant, le min-value pour tcp-port doit être positif.
Obligatoire ? Non

'max-value'

Utilisez cet attribut pour définir la valeur maximale pour les paramètres de type number ou tcp-port.
Assurez-vous que la valeur maximale est supérieure à la valeur minimale, si elle est définie.
Exemple:
-
      name: audio-port
      type: tcp-port
      min-value: 5000
      max-value: 15000
Obligatoire ? Non

'min-length'

Utilisez cet attribut pour définir la longueur minimale des valeurs acceptées pour un paramètre de type « chaîne de caractères ».
Assurez-vous que la longueur minimale des caractères définis comme valeurs est supérieure ou égale à zéro.
Exemple :
-
      name: appname
      type: string
      min-length: 3
Obligatoire ? Non

'max-length'

Utilisez cet attribut pour définir la longueur maximale des valeurs acceptées pour un paramètre de type « chaîne de caractères ».
Assurez-vous que la longueur maximale des valeurs est supérieure ou égale à la longueur des caractères définis dans min-length.
Exemple :
-
      name: appname
      type: string
      max-length: 64
Obligatoire ? Non

'min-items'

Utilisez cet attribut pour définir le nombre minimal d'éléments dans un paramètre qui est une liste.
Assurez-vous que le nombre minimal d'éléments est supérieur ou égal à zéro.
Exemple :
-
      name: server-ips
      type: ipaddress[]
      min-items: 2
Obligatoire ? Non

'max-items'

Utilisez cet attribut pour définir le nombre maximal d'éléments dans un paramètre qui est une liste.
Assurez-vous que le nombre maximal d'éléments est 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
Obligatoire ? Non

'interface graphique'

Utilisez cet attribut pour personnaliser la mise en page du paramètre dans l'interface graphique de NetScaler Console.
Obligatoire ? Non

'colonnes'

Cet attribut est un sous-attribut de l'attribut gui. Utilisez cet attribut pour définir le nombre de colonnes à afficher pour les paramètres type: object[] dans l'interface graphique de NetScaler Console.
Obligatoire ? Non

'modifiable'

Cet attribut est un sous-attribut de l'attribut gui. Utilisez cet attribut pour spécifier si le paramètre peut être mis à jour après la création de la configuration. Définissez cet attribut uniquement sur des types de paramètres simples tels que chaîne, booléen ou nombre.
Si la valeur est définie sur false, le champ du paramètre est grisé lorsque vous mettez à jour la configuration.
Obligatoire ? Non

'collapse_pane'

Cet attribut est un sous-attribut de l'attribut gui. Utilisez cet attribut pour spécifier si le volet définissant la disposition de ce paramètre d'objet est réductible.
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
Exemple d'une section de paramètres complète :

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
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

'Disposition'

Cet attribut est un sous-attribut de l'attribut gui. Utilisez cet attribut pour afficher les valeurs de la liste sous forme de boutons radio. Définissez l'attribut layout sur radio dans la section des paramètres d'une définition de StyleBook. Il s'applique au paramètre qui possède l'attribut allowed-values. Lorsque vous créez un pack de configuration, l'interface graphique de NetScaler Console affiche les valeurs de la liste allowed-values sous forme de boutons radio.
Exemple :
-
    gui:
        layout: radio
    allowed-values:
        - One
        - Two
        - Three
Les valeurs Un, Deux et Trois apparaissent sous forme de boutons radio dans l'interface graphique de NetScaler Console.

'dependent-parameters'

Cet attribut est un sous-attribut de l'attribut gui. Il contrôle dynamiquement l'apparence du paramètre ou sa valeur initiale dans le formulaire de configuration StyleBook en fonction de la valeur spécifiée dans un autre paramètre.
Spécifiez cet attribut sur un paramètre source qui contrôle le comportement du paramètre sur le formulaire. Vous pouvez inclure plusieurs conditions qui contrôlent d'autres paramètres. Par exemple, un paramètre source protocol peut avoir un paramètre dépendant certificate, qui n'apparaît que si la valeur du paramètre protocol est SSL.
Chaque condition peut avoir les attributs suivants :
  • target-parameter : Spécifiez le paramètre cible auquel cette condition s'applique.
  • matching-values : Spécifiez la liste des valeurs du paramètre source qui déclenchent l'action.
  • action : Spécifiez l'une des actions suivantes sur le paramètre ciblé :
    • read-only : Le paramètre est rendu en lecture seule.
    • show : Le paramètre apparaît dans le formulaire s'il est masqué.
    • hide : Le paramètre est supprimé du formulaire.
    • set-value : La valeur du paramètre est définie sur la valeur spécifiée dans l'attribut de valeur.
  • value : La valeur du paramètre cible si l'action est set-value.
Lorsqu'une entrée utilisateur correspond aux valeurs spécifiées sur le paramètre source, l'apparence ou la valeur du paramètre cible change en fonction de l'action spécifiée.
Exemple :
 -
    name: lb-virtual-port
    label: "Load Balanced App Virtual Port"
    description: "TCP port representing the Load Balanced application"
    type: tcp-port
    gui:
      updatable: false
      dependent-parameters:
            -
              matching-values:
                - 80
              target-parameter: $parameters.lb-service-type
              action: set-value
              allowed-values:
              - HTTP
              - TCP
              - UDP

    default: 80
Dans cet exemple, le paramètre dépendant est spécifié sous le paramètre lb-virtual-port (paramètre source).
Lorsque la valeur du paramètre source est définie sur 80, le paramètre lb-service-type déclenche l'action set-value. En conséquence, un utilisateur est autorisé à sélectionner l'une des options suivantes :
  • HTTP
  • TCP
  • UDP

is_policy_expression

Cet attribut est un sous-attribut de l'attribut gui. Utilisez cet attribut pour permettre à l'éditeur d'expressions de stratégie de composer une expression de stratégie. Définissez is_policy_expression sur true dans la définition du paramètre. Cet attribut ne peut être utilisé que sur les paramètres de type 'string'.
Exemple :
parameters:
  -

    name: expression
    type: string
    label: Expression
    required: true
    gui:
      is_policy_expression: true