190 lines
6.3 KiB
ReStructuredText
190 lines
6.3 KiB
ReStructuredText
Variable
|
|
========
|
|
|
|
Un variable
|
|
-----------
|
|
|
|
Une variable est forcement dans une famille. Il faut donc déjà avoir créer une famille.
|
|
|
|
Une variable est déjà un nom. C'est à dire qu'on pourra utiliser plus tard la variable via ce nom.
|
|
|
|
<variable name="my_variable"/>
|
|
|
|
Description et aide sur la variable
|
|
----------------------------------
|
|
|
|
En plus d'un nom, il est possible de mettre une "description" à la variable. C'est une information "utilisateur" qui nous permettra d'avoir des informations complémentaires sur le contenu de cette variable :
|
|
|
|
<variable name="my_variable" description="This is a greate variable"/>
|
|
|
|
En plus de la description, il est possible de préciser une aide complémentaire :
|
|
|
|
<variable name="my_variable" help="This is a greate variable"/>
|
|
|
|
Le type de la variable
|
|
----------------------
|
|
|
|
Une variable a un type. Ce type permet de définir les valeurs acceptées par cette variable :
|
|
|
|
- string : chaine de caractère (type par défaut)
|
|
- number : un nombre
|
|
- float : un chiffre flottant
|
|
- boolean : True ou False si aucune valeur n'est défini la valeur par défaut cette variable sera True
|
|
- password : un mot de passe
|
|
- mail : une adresse mail
|
|
- filename : nom de fichier au sens Unix (exemple : '/etc/passwd')
|
|
- date : une date au format "%Y-%m-%d" (exemple : "2021-01-30")
|
|
- unix_user : nom d'utilisateur au sens Unix
|
|
- ip : n'importe quelle adresse IPv4
|
|
- cidr : n'importe quelle adresse IPv4 au format CIDR
|
|
- local_ip : adresse IPv4 sur un réseau local, si l'adresse IPv4 n'est pas local, un warning sera afficher mais la valeur sera accepté tout de même
|
|
- netmask : masque d'une adresse IPv4
|
|
- network : adresse réseau
|
|
- network_cidr : adresse réseau au format CIDR
|
|
- broadcast : adresse de diffusion
|
|
- netbios : nom netbios
|
|
- domain : nom de domaine
|
|
- hostname : nom d'hôte
|
|
- web_address : adresse web (http://www.cadoles.com/)
|
|
- port : port
|
|
- mac : adresse MAC
|
|
- schedule : périodicité du schedule, les valeurs possibles sont "none", "daily", "weekly" ou "monthly"
|
|
- schedulemod : type de schedule, les valeurs possibles sont "pre" ou "post"
|
|
|
|
Pour définir le type d'une variable :
|
|
|
|
<variable name="my_variable" type="number"/>
|
|
|
|
Variable à valeur multiple
|
|
--------------------------
|
|
|
|
Par défaut une variable ne peut acceuillir qu'une seule valeur. Il peut être utile de pouvoir spécifier plusieurs valeurs à une même variable.
|
|
|
|
Pour définir une variable à valeur multiple :
|
|
|
|
<variable name="my_variable" multi="True"/>
|
|
|
|
Mode de la variable
|
|
-------------------
|
|
|
|
Le mode par défaut d'une variable correspond au mode de la famille.
|
|
|
|
Pour définir le mode :
|
|
|
|
<variable name="my_variable" mode="expert"/>
|
|
|
|
Cacher une variable
|
|
-------------------
|
|
|
|
Il est possible de cacher une variable.
|
|
|
|
Cacher une variable signifie qu'elle ne sera pas visible lorsqu'on modifie la configuration du service.
|
|
Par contre cette variable sont accessibles lorsqu'on va l'utiliser.
|
|
|
|
Pour cacher une variable :
|
|
|
|
<variable name="my_variable" hidden="True"/>
|
|
|
|
Désactiver une variable
|
|
-----------------------
|
|
|
|
Il est possible de désactiver une variable.
|
|
|
|
Désactiver une variable signifie qu'elle ne sera pas visible lorsqu'on modifie la configuration du service mais également lorsqu'on va l'utiliser.
|
|
|
|
Pour désactiver une variable :
|
|
|
|
<variable name="my_variable" disabled="True"/>
|
|
|
|
Variable obligatoire
|
|
--------------------
|
|
|
|
Variable dont une valeur est requise :
|
|
|
|
<variable name="my_variable" mandatory="True"/>
|
|
|
|
Valeur par défaut d'une variable
|
|
--------------------------------
|
|
|
|
Il est possible de fixer les valeurs par défaut d'une variable :
|
|
|
|
<variable name="my_variable">
|
|
<value>value</value>
|
|
</variable>
|
|
|
|
Pour une variable multiple, il est possible de préciser plusieurs valeurs :
|
|
|
|
<variable name="my_variable" multi="True">
|
|
<value>value 1</value>
|
|
<value>value 2</value>
|
|
</variable>
|
|
|
|
Une valeur par défaut peut également être `une valeur calculer <fill.rst>`.
|
|
|
|
Redéfinir une variable
|
|
----------------------
|
|
|
|
Il est possible de définir une variable dans un dictionnaire et de changer son comportement dans une second dictionnaire.
|
|
|
|
Attention trois attributs ne sont redéfinisable :
|
|
|
|
- name
|
|
- type
|
|
- multi
|
|
|
|
Créons notre variable :
|
|
|
|
<variable name="my_variable"/>
|
|
|
|
Et redéfinisons là :
|
|
|
|
<variable name="my_variable" redefine="True" description="New description"/>
|
|
|
|
Créer une variable inexistante
|
|
------------------------------
|
|
|
|
Il est parfois utile de créer une variable si elle n'existe pas dans un autre dictionnaire :
|
|
|
|
<variable name="my_variable" exists="False"/>
|
|
|
|
Si cette variable existe dans un autre dictionnaire, elle ne sera pas modifier ni recréé
|
|
|
|
Redéfinir une variable si elle existe
|
|
-------------------------------------
|
|
|
|
Parfois on veut pouvoir redéfinir une variable mais seulement dans le cas où elle existe déjà :
|
|
|
|
<variable name="my_variable" redefine="True" exists="True" hidden="True"/>
|
|
|
|
Variable à valeur automatiquement modifiée
|
|
------------------------------------------
|
|
|
|
Une variable avec valeur automatiquement modifiée est une variable dont la valeur sera considéré comme modifié quand le serveur sera déployé.
|
|
|
|
Voici une variable a valeur automatiquement modifiée :
|
|
|
|
<variable name="my_variable" auto_save="True">
|
|
<value>my_value</value>
|
|
</variable>
|
|
|
|
Dans ce cas la valeur est fixée à la valeur actuelle.
|
|
Par exemple, si la valeur de cette variable est issue d'un calcul, la valeur ne sera plus recalculée.
|
|
|
|
Ces variables sont généralement des variables obligatoires. En effet ces variable ne sont automatiquement modifiées que si elles sont une valeurs.
|
|
|
|
Variable à valeur en lecture seule automatique
|
|
----------------------------------------------
|
|
|
|
Une variable avec valeur en lecture seule automatique est une variable dont la valeur ne sera plus modifiable par l'utilisateur quand le serveur sera déployé.
|
|
|
|
Voici un variable à valeur en lecture seule automatique :
|
|
|
|
<variable name="my_variable" auto_freeze="True"/>
|
|
|
|
Dans ce cas la valeur est fixée à la valeur actuelle et elle ne sera plus modifiable par l'utilisateur.
|
|
Par exemple, si la valeur de cette variable est issue d'un calcul, la valeur ne sera plus recalculée.
|
|
|
|
Ces variables sont généralement des variables obligatoires. En effet ces variable ne sont en lecteur seul que si elles sont une valeurs.
|
|
|
|
<!ATTLIST variable test CDATA #IMPLIED>
|