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 que cette section soit facultative, la plupart des StyleBook peuvent en avoir besoin. Vous pouvez considérer la section Paramètres pour définir les champs des utilisateurs qui 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. 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 :
‘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 plus d’alphabets, de nombres, de trait d’union (-) ou de 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’
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 pour 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. -
number: 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: chaîne représentant une adresse IPv4 ou IPv6 valide. -
ipnetwork: Il a deux parties. La première partie est l’adresse IP et la deuxième partie est le masque de réseau.
Le masque de réseau est représenté par une longueur de masque réseau (
netmask-len) ou une adresse IP de masque de réseau (netmask_ip). La longueur du masque de réseau est un entier compris entre 0 et 32 et 0 à 128 pour une adresse IPv6. Il est utilisé pour déterminer le nombre d’adresses IP dans un réseau. -
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 ADM 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 charger les fichiers directement à partir de votre système local lorsque vous créez une configuration StyleBook à l’aide de l’interface graphique ADM. Le fichier de certificat téléchargé est stocké dans le répertoire/var/mps/tenants/\<tenant_path>/ns_ssl_certsd’ADM.Le fichier de certificat est ajouté à la liste des certificats gérés par ADM.
-
keyfile: Représente un fichier de clé de certificat. Cette valeur vous permet de charger le fichier directement à partir de votre système local lorsque vous créez une configuration StyleBook à l’aide de l’interface graphique ADM. Le fichier de certificat téléchargé est stocké dans le répertoire/var/mps/tenants/\<tenant_path>/ns_ssl_keysd’ADM.Le fichier de clé de certificat est ajouté à la liste des clés de certificat gérées par ADM.
-
file: Représente un fichier. -
object: Ce type est utilisé lorsque vous souhaitez regrouper plusieurs paramètres associés sous un élément parent. Spécifiez 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. -
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 indiquant son type.
Un paramètre peut également avoir un type qui est la liste des types. Pour ce faire, ajoutez [] à la fin du type. Par exemple, si l’ type attribut 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’ network attribut pour allouer automatiquement une adresse IP à partir d’un réseau ADM IPAM.
ADM 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
<!--NeedCopy-->
Dans cet exemple, le virtual-ip champ alloue automatiquement une adresse IP à partir de network-1. L’adresse IP est libérée sur le réseau lorsque la configuration est supprimée.
‘allocation dynamique’
L’ dynamic-allocation attribut est ajouté dans la définition du paramètre de type:ipaddress. Utilisez cet attribut pour répertorier dynamiquement les réseaux ADM IPAM. Cet attribut peut prendre true soit soit false en entrée. Pour type: ipaddress, spécifiez l’ dynamic-allocation: true attribut pour répertorier dynamiquement les réseaux ADM IPAM qui sont dans ADM. Dans le formulaire de création du pack de configuration, vous pouvez effectuer les opérations suivantes :
-
Sélectionnez le réseau IPAM requis dans la liste.
-
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, l’ADM 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
<!--NeedCopy-->
Dans cet exemple, le virtual-ip champ répertorie les réseaux ADM IPAM qui sont dans ADM. 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 sur le réseau lorsque la configuration est supprimée.
‘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 le paramètre « key ».
Lorsque vous créez des configurations différentes à partir du même StyleBook (sur des instances ADC identiques ou différentes), chaque configuration a une valeur différente ou 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 et l’utilisateur doit fournir une valeur pour ce paramètre lors de la création de configurations.
L’interface graphique ADM oblige l’utilisateur à fournir une valeur valide pour ce paramètre.
La valeur par défaut est false.
Obligatoire ? Non
« valeurs alloué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 ADM, 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] (#allow -new-values).
Remarque
Si vous souhaitez afficher les valeurs de la liste sous forme d’options radio, définissez l’attribut [
layout] (#layout).
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 de tcp-ports, où chaque élément de la liste ne peut avoir que des valeurs spécifiées dans allowed-values.
-
name: tcpports
type: tcp-port[]
allowed-values:
- 80
- 81
- 8080
- 8081
<!--NeedCopy-->
Obligatoire ? Non
‘autorise-nouvelles valeurs’
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 ADM, 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 allowed-values attributs allow-new-values et dans une combinaison. Cette combinaison vous permet de définir une liste de valeurs suggérées pour un paramètre et d’accepter de nouvelles valeurs.
-
name: port
type: tcp-port
allowed-values:
- 80
- 81
- 8080
allow-new-values: true
<!--NeedCopy-->
Dans cet exemple, un utilisateur peut choisir entre 80, 81, 8080 ou entrer 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 affecter 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
<!--NeedCopy-->
Exemple 2 :
Pour répertorier les valeurs par défaut du paramètre :
-
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-valeur’
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
<!--NeedCopy-->
Les min-value nombres peuvent être négatifs. Cependant, le min-value for tcp-port doit être positif.
Obligatoire ? Non
‘max-value’
Utilisez cet attribut pour définir la valeur maximale des 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
<!--NeedCopy-->
Obligatoire ? Non
‘min-longueur’
Utilisez cet attribut pour définir la longueur minimale des valeurs acceptées pour un paramètre de type « string. »
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
<!--NeedCopy-->
Obligatoire ? Non
‘longueur’
Utilisez cet attribut pour définir la longueur maximale des valeurs acceptées pour un paramètre de type « string. »
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
<!--NeedCopy-->
Obligatoire ? Non
‘min-items’
Utilisez cet attribut pour définir le nombre minimal d’éléments d’un paramètre qui est une liste.
Assurez-vous que le nombre minimum d’articles est 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.
Assurez-vous que le nombre maximal d’éléments est supérieur au nombre minimal d’éléments si défini.
Exemple :
-
name: server-ips
type: ipaddress[]
min-items: 2
max-items: 250
<!--NeedCopy-->
Obligatoire ? Non
‘gui’
Utilisez cet attribut pour personnaliser la disposition du paramètre dans l’interface graphique ADM.
Obligatoire ? Non
‘colonnes’
Cet attribut est un sous-attribut de l’ gui attribut. Utilisez cet attribut pour définir le nombre de colonnes pour afficher les type: object[] paramètres dans l’interface graphique ADM.
Obligatoire ? Non
‘updatable’
Cet attribut est un sous-attribut de l’ gui attribut. 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éenne ou nombre.
Si la valeur est définie sur false, le champ paramètre est grisé lorsque vous mettez à jour la configuration.
Obligatoire ? Non
‘collapse_pane’
Cet attribut est un sous-attribut de l’ gui attribut. 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
<!--NeedCopy-->
Exemple de 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-->
‘mise en page ‘
Cet attribut est un sous-attribut de l’ gui attribut. Utilisez cet attribut pour afficher les valeurs de liste sous forme de boutons radio. Définissez l’ layout attribut sur radio dans la section des paramètres d’une définition StyleBook. Elle s’applique au paramètre qui a l’attribut [allowed-values] (#allowed -values). Lorsque vous créez un pack de configuration, l’interface graphique ADM affiche les valeurs de la allowed-values liste sous forme de boutons radio.
Exemple :
-
gui:
layout: radio
allowed-values:
- One
- Two
- Three
<!--NeedCopy-->
Les valeurs Un, Deux et Trois apparaissent sous forme de boutons radio dans l’interface graphique ADM.
‘paramètres-dépendants’
Cet attribut est un sous-attribut de l’ gui attribut. Il contrôle dynamiquement l’apparence du paramètre ou sa valeur initiale dans l’écran 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 protocol paramètre est SSL.
Chaque condition peut avoir les attributs suivants :
-
target-paramètre : spécifiez le paramètre cible auquel cette condition s’applique.
-
valeurs de correspondance : spécifiez la liste des valeurs du paramètre source qui déclenche l’action.
-
action : spécifiez l’une des actions suivantes sur le paramètre ciblé :
-
read-only: le paramètre est 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 value.
-
-
value : 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
<!--NeedCopy-->
Dans cet exemple, le paramètre dépendant est spécifié sous le lb-virtual-port paramètre (paramètre source).
Lorsque la valeur du paramètre source est définie sur 80, le lb-service-type paramètre déclenche l’ set-value action. Par conséquent, un utilisateur est autorisé à sélectionner l’une des options suivantes :
- HTTP
- TCP
- UDP
Dans cet article
- ‘nom’
- ‘étiquette’
- ‘description’
- ‘type’
- ‘réseau’
- ‘allocation dynamique’
- ‘clé’
- « requis »
- « valeurs allouées »
- ‘autorise-nouvelles valeurs’
- « par défaut »
- « modèle »
- ‘Min-valeur’
- ‘max-value’
- ‘min-longueur’
- ‘longueur’
- ‘min-items’
- ‘max-items’
- ‘gui’
- ‘colonnes’
- ‘updatable’
- ‘collapse_pane’
- ‘mise en page ‘
- ‘paramètres-dépendants’