Les substitutions sont utilisées pour définir des noms abrégés qui peuvent remplacer des expressions complexes dans le StyleBook, rendant ainsi le StyleBook plus lisible.

Les substitutions sont également utiles lorsque la même expression ou valeur est utilisée de manière répétée dans le StyleBook, par exemple, une valeur constante. L'utilisation d'un nom de substitution pour un paramètre vous permet de mettre à jour uniquement la valeur de substitution au lieu de mettre à jour toutes les occurrences du paramètre dans le StyleBook, ce qui pourrait être source d'erreurs.

Les substitutions sont également utilisées pour définir des mappages entre des valeurs, comme décrit dans les exemples plus loin dans ce document.

Chaque substitution de la liste est composée d'une clé et d'une valeur. La valeur peut être une valeur simple, une expression, une fonction ou une carte.

Dans l'exemple suivant, deux substitutions sont définies. La première est http-port qui peut être utilisée comme raccourci pour 8181. En utilisant une substitution, vous pouvez y faire référence dans le reste du StyleBook en tant que $substitutions.http-port au lieu de 8181.

Substitutions :

http-port: 8181

Cela vous permet de spécifier un nom mnémonique pour un numéro de port et de définir ce numéro de port à un seul endroit dans le StyleBook, quel que soit le nombre de fois où il est utilisé. Si vous souhaitez modifier le numéro de port en 8080, vous pouvez le modifier dans la section de substitution, et le changement prendra effet partout où le nom mnémonique http-port est utilisé. L'exemple suivant montre comment une substitution est utilisée dans un composant.

Une substitution peut également être une expression complexe. L'exemple suivant montre comment deux substitutions utilisent des expressions.

Une expression de substitution peut également utiliser des expressions de substitution existantes, comme le montre l'exemple suivant.

Une autre fonctionnalité utile des substitutions est les cartes, où vous pouvez mapper des clés à des valeurs. Voici un exemple de substitution de carte.

L'exemple suivant montre comment utiliser les cartes secure-port et secure-protocol.

Ici, si l'utilisateur du StyleBook spécifie la valeur booléenne « true » pour le paramètre is-secure, ou coche la case correspondant à ce paramètre dans l'interface graphique de NetScaler Console, la propriété servicetype de ce composant se voit attribuer la valeur SSL et la propriété de port se voit attribuer la valeur 443. Cependant, si l'utilisateur spécifie « false » pour ce paramètre ou décoche la case correspondante dans l'interface graphique de NetScaler Console, la propriété servicetype se voit attribuer la valeur HTTP et le port se voit attribuer la valeur 80.

L'exemple suivant montre comment utiliser les substitutions comme fonction. Une fonction de substitution peut prendre un ou plusieurs arguments. Les arguments peuvent être de type simple, par exemple, chaîne de caractères, nombre, ipaddress, booléen et d'autres types.

substitutions :

form-lb-name(nom) : $name + "-lb"

Dans cet exemple, nous définissons une fonction de substitution « form-lb-name » qui prend un argument de chaîne appelé « name » et l'utilise pour créer une chaîne qui ajoute le suffixe « -lb » à la chaîne de l'argument name. Une expression utilisant cette fonction de substitution peut être écrite comme suit :

$substitutions.form-lb-name("my")

Elle renvoie my-lb

Considérons un autre exemple :

substitutions :

cspol-priority(priority): 10100 - 100 * $priority

La substitution cspol-priority est une fonction qui prend un argument appelé priority et l'utilise pour calculer une valeur. Dans le reste du StyleBook, cette substitution peut être utilisée comme indiqué dans l'exemple suivant :

Voici un exemple de substitution appelée slist dont la valeur est une liste :

La valeur d'une substitution peut également être un dictionnaire de paires clé-valeur, comme le montre l'exemple suivant d'une substitution appelée sdict ci-dessous :

Vous pouvez créer des attributs plus complexes en combinant les listes et les dictionnaires. Par exemple, une substitution appelée slistofdict renvoie une liste de paires clé-valeur.

Mais, dans l'exemple suivant, une substitution sdictoflist renvoie une paire clé-valeur, où la valeur elle-même est une autre liste.

Dans les composants, ces substitutions peuvent être utilisées dans les constructions condition, properties, repeat, repeat-condition.

L'exemple de composant suivant montre comment une substitution peut être utilisée pour spécifier les propriétés :

Un cas d'utilisation pour définir une substitution dont la valeur est une liste ou un dictionnaire est lorsque vous configurez un serveur virtuel de commutation de contenu et plusieurs serveurs virtuels d'équilibrage de charge. Étant donné que tous les serveurs virtuels lb liés au même serveur virtuel cs peuvent avoir une configuration identique, vous pouvez utiliser la liste de substitution et le dictionnaire pour construire cette configuration afin d'éviter de répéter cette configuration pour chaque serveur virtuel lb.

L'exemple suivant montre la substitution et le composant dans les cs-lb-mon StyleBooks pour créer une configuration de serveur virtuel de commutation de contenu. Lors de la construction des propriétés des cs-lb-mon StyleBooks, la substitution complexe "lb-properties" spécifie les propriétés des serveurs virtuels lb associés au serveur virtuel cs. La substitution "lb-properties" est une fonction qui prend le nom, le type de service, l'adresse IP virtuelle, le port et les serveurs comme paramètres et génère une paire clé-valeur comme valeur. Dans le composant cs-pools, nous attribuons la valeur de cette substitution à un paramètre lb-pool pour chaque pool.