Configuration
Les paramètres d'ansible.cfg et les variables d'environnement que Volant lit, section par section, avec leurs valeurs par défaut.
Volant lit le même ansible.cfg qu’ansible-playbook, et s’arrête au premier fichier qu’il trouve :
- le fichier nommé par
ANSIBLE_CONFIG ./ansible.cfg~/.ansible.cfg/etc/ansible/ansible.cfg
Volant ignore ./ansible.cfg quand le répertoire de travail est accessible en écriture à d’autres utilisateurs (bit de mode o+w), comme le fait ansible-playbook. Un autre utilisateur local pourrait y avoir déposé le fichier. Le sticky bit et le propriétaire du répertoire n’y changent rien. Volant affiche [WARNING]: Ansible is being run in a world writable directory (...), ignoring it as an ansible.cfg source. sur la sortie d’erreur et continue avec le fichier suivant. Un fichier nommé par ANSIBLE_CONFIG est lu quel que soit le mode du répertoire de travail.
Pour chaque paramètre, la variable d’environnement l’emporte sur le fichier, et l’option de ligne de commande l’emporte sur les deux. Les clés que Volant n’utilise pas sont ignorées, comme Ansible ignore celles dont il ne se sert pas.
Un fichier qui existe mais ne peut pas être lu est ignoré, et l’exécution continue avec les valeurs par défaut. Volant affiche d’abord un avertissement, ce qu’Ansible ne fait pas : un fichier que vous avez écrit et que le processus ne peut pas ouvrir mérite une ligne, et un avertissement ne change pas le code de sortie.
[defaults]
Section intitulée « [defaults] »Les sources d’inventaire, sous forme de liste séparée par des virgules. Voir Inventaires.
Nombre de secondes d’attente d’une connexion. Il devient ConnectTimeout sur la ligne de commande de ssh.
L’utilisateur sous lequel se connecter. Sans lui, ssh en choisit un.
La clé privée avec laquelle ssh s’authentifie.
Activé, une clé d’hôte inconnue rend l’hôte injoignable. Désactivé, Volant ajoute StrictHostKeyChecking=no et UserKnownHostsFile=/dev/null : une clé inconnue est acceptée et n’est pas enregistrée.
Le répertoire de chaque hôte qui contient le cache de l’agent.
Le nombre d’hôtes sur lesquels un play travaille à la fois. Zéro, ou une valeur qui n’est pas un nombre, est rejeté avant le début de l’exécution. Les playbooks lisent la valeur courante sous le nom ansible_forks.
La stratégie d’un play qui n’en nomme aucune : linear, free, host_pinned ou debug, aussi sous ansible.builtin.. Tout autre nom affiche l’avertissement de dépréciation d’ansible-core pour les plugins de stratégie hors de ansible.builtin. Un plugin qui hérite de l’une d’elles sans rien ajouter s’exécute comme cette stratégie, et tout autre nom est refusé.
Le répertoire de chaque hôte qui contient les fichiers d’état des tâches async. ansible_async_dir le remplace.
Ouvre le débogueur après chaque tâche en échec ou injoignable.
Affiche task path: <file>:<line> avant la ligne fatal: d’une tâche en échec. À partir de -vv, la ligne suit déjà chaque bannière de tâche : le réglage ne change donc rien. La ligne failed: d’un élément de boucle et un hôte injoignable n’ont pas de ligne de chemin. Comme dans Ansible, y, yes, on, true, t et 1 l’activent quelle que soit la casse, et tout autre mot, variable vide comprise, le laisse désactivé.
Colore la sortie même quand ce n’est pas un terminal, comme le demandent les journaux de CI. Il l’emporte sur nocolor, ANSIBLE_NOCOLOR et NO_COLOR ; seul --no-color l’emporte sur lui. Dans un diff, seules les lignes que le difflib d’Ansible a produites à partir de before et after sont colorées.
Ne colore jamais la sortie. force_color l’emporte sur lui.
Les événements qui affichent un traceback, en liste séparée par des virgules. Avec error ou always, un plugin d’action Python en échec qui regroupe des erreurs, comme gather_facts avec ses modules de facts, affiche son traceback et ceux de ses modules, et l’enregistre comme exception. Tout autre échec garde (traceback unavailable).
Affiche les avis [DEPRECATION WARNING] et la ligne qui explique comment les arrêter. Réglez-le sur False pour n’afficher ni l’un ni l’autre.
Une condition dont le résultat n’est pas un booléen échoue par défaut. Réglée sur True, elle suit la vérité de son résultat et affiche un [DEPRECATION WARNING].
Un fichier auquel s’ajoute chaque ligne que l’exécution affiche, un enregistrement par message comme Ansible l’écrit : 2026-10-30 18:34:18,430 p=<pid> u=<user> n=ansible INFO| TASK [...] ***, WARNING pour un [WARNING] et ERROR pour un [ERROR].
Le nombre de -v jusqu’auquel une ligne va dans log_path même quand l’exécution ne l’affiche pas.
Avertit quand l’inventaire ne contient aucun hôte, si bien qu’il ne reste que le localhost implicite. all ne désigne pas cet hôte.
Un fichier YAML dont module_rejectlist nomme des modules interdits, relatif au fichier de configuration. Une tâche qui en nomme un arrête le playbook avant son lancement, à cette tâche, avec couldn't resolve module/action, comme pour un module mal orthographié. Seul le nom tel que la liste l’écrit est refusé : copy dans la liste laisse ansible.builtin.copy utilisable. ansible-core 2.19.12 ne lit aucune variable d’environnement pour cette option.
Fait garder ses defaults et ses vars à un rôle de roles: ou d’un import_role qui ne dit pas public. À false, un include_role qui ne dit pas public les prête aussi. Sans réglage, seul un include_role les garde.
merge pose un mapping sur un mapping de même nom clé par clé, entre deux sources de variables quelles qu’elles soient et entre deux sources d’inventaire. replace garde entière la valeur de la source la plus haute. L’option est dépréciée dans Ansible, qui la respecte encore sans afficher d’avertissement.
Exécute les handlers notifiés même sur les hôtes qui ont échoué.
Ce que reçoit une clé YAML écrite deux fois dans un même mapping : warn garde la dernière valeur et indique où se trouve la seconde clé, error refuse le fichier, ignore garde la dernière valeur sans rien dire.
Les modules de facts que lance la collecte des facts d’une play, smart (setup) sauf réglage. Une liste littérale dans les plays, leurs tâches ou l’inventaire (ansible_facts_modules) est lue aussi ; un module que seul un template nomme ne peut pas être lancé.
Le Python sous lequel un module tourne sur un hôte qui ne définit pas ansible_python_interpreter ; la variable de l’hôte l’emporte sur ce réglage. auto et auto_silent cherchent l’interpréteur sur l’hôte, et auto_silent omet l’avertissement qui nomme celui trouvé. auto_legacy et auto_legacy_silent agissent comme auto et auto_silent et ajoutent la dépréciation d’ansible-core. Toute autre valeur est le chemin de l’interpréteur.
Indique si from_json refuse une chaîne qui contient un surrogate isolé, comme \udc80. Désactivé, la valeur le garde et s’affiche avec ? à sa place, avec un avertissement.
Affiche, après le récapitulatif, les statistiques que set_stats a collectées.
Le callback qui affiche l’exécution. default affiche les bannières, une ligne par résultat et le récapitulatif. minimal affiche chaque résultat comme la commande ad hoc, host | CHANGED | rc=0 >> et la sortie pour une commande, sinon host | SUCCESS => et le résultat en JSON, sans bannière, sans récapitulatif et sans ligne par élément de boucle. oneline affiche les mêmes résultats sur une ligne chacun ; ansible-core 2.19.12 le déprécie et Volant affiche son avertissement une fois sur la sortie d’erreur. tree n’affiche rien sur la sortie standard. Les noms en ansible.builtin. fonctionnent aussi. yaml arrête l’exécution avec le code de sortie 1 et l’erreur que community.general affiche depuis 12.0.0, qui a retiré ce plugin : callback_result_format = yaml le remplace. json et ansible.posix.json n’affichent rien pendant l’exécution, puis toute l’exécution en un seul document JSON : chaque play et chaque tâche avec ses temps, son id et son chemin, le résultat de chaque hôte tel que la tâche l’a rendu avec son action, le récapitulatif par hôte et les données de set_stats quand show_custom_stats est activé. Les caractères hors ASCII sont écrits \uXXXX. Tout autre nom, comme community.general.unixy, se charge par l’ansible-core du contrôleur ; un nom qu’il ne trouve pas arrête l’exécution avant le premier play avec [ERROR]: Could not load '<name>' callback plugin. et le code de sortie 1.
Comment default et minimal écrivent un résultat : json, ou yaml, où le résultat suit => sur les lignes suivantes, indenté de quatre espaces, et un texte avec des retours à la ligne est un bloc littéral. Toute autre valeur arrête l’exécution avant le premier play avec le code de sortie 5. oneline écrit toujours du JSON.
Le pretty_results de default et minimal. Non défini, un résultat JSON n’est indenté que pour un debug, un assert et à partir de -vvv, et un résultat YAML est lisible. Activé, chaque résultat est indenté de quatre espaces. Désactivé, aucun ne l’est, pas même un debug. Le YAML lisible écrit stdout_lines et stderr_lines en <omitted> à côté de leur texte, imbrique de quatre espaces et retire les espaces et tabulations de fin d’un bloc de texte pour qu’il reste un bloc ; le YAML non lisible garde chaque valeur telle quelle et imbrique de deux. Un mot qui n’est pas un booléen vaut désactivé.
Espaces par niveau du document du callback json. Zéro ou moins l’écrit sur une seule ligne.
D’autres callbacks à exécuter à côté de celui de stdout, en liste séparée par des virgules. Volant exécute junit, qui écrit un rapport JUnit XML par playbook dans JUNIT_OUTPUT_DIR (~/.ansible.log par défaut) et lit les autres variables JUNIT_*, tree, qui écrit le dernier résultat de chaque hôte dans un fichier de [callback_tree] directory (ANSIBLE_CALLBACK_TREE_DIR, ~/.ansible/tree par défaut), et, quand ansible.posix est installé sur le contrôleur, ansible.posix.timer et ansible.posix.profile_tasks avec leurs options ([callback_profile_tasks], PROFILE_TASKS_*). Tout autre nom se charge par l’ansible-core du contrôleur ; un nom qu’il ne trouve pas affiche [WARNING]: Skipping callback plugin '<name>', unable to load et l’exécution continue. volant.compat.record, qui enregistre les exécutions d’ansible-playbook, est ignoré sans avertissement.
D’autres répertoires où chercher des plugins de callback, séparés par :. Un plugin trouvé là, ou dans callback_plugins/ à côté du playbook, s’exécute par l’ansible-core du contrôleur dans un processus Python à lui. Une exécution sans un tel plugin ne démarre pas Python pour cela.
Si la commande ad hoc charge les callbacks ci-dessus. Désactivé, elle affiche via minimal, ou oneline avec -o, quoi que dise stdout_callback. Voir la commande ad hoc.
Un fichier qui contient le mot de passe vault, ou un exécutable qui l’affiche. La variable d’environnement remplace la valeur du fichier, et la ligne de commande s’ajoute à celle qui a gagné. Voir Vault.
Des identités vault séparées par des virgules, chacune écrite label@source, où la source est un fichier, un exécutable ou prompt. La variable d’environnement remplace la liste du fichier, et la ligne de commande s’ajoute à celle qui a gagné.
L’identifiant vault que volant vault encrypt utilise quand --encrypt-vault-id n’est pas donné. Voir Vault.
L’éditeur que volant vault create et edit lancent. La dernière variable définie l’emporte, puis le fichier, puis vi. Voir Vault.
L’endroit où volant vault create et edit gardent la copie privée sur laquelle travaille l’éditeur.
Le programme dans lequel volant vault view fait passer la sortie sur un terminal. La dernière variable définie l’emporte, puis le fichier.
Où chercher les rôles, après <playbook_dir>/roles et avant <playbook_dir> lui-même. Voir Rôles.
Aussi lu sous le nom collections_paths, et depuis ANSIBLE_COLLECTIONS_PATHS, qui l’emporte sur ANSIBLE_COLLECTIONS_PATH. Où chercher un nom de rôle en trois parties comme acme.demo.hello. Les modules d’une collection sont trouvés par l’ansible-core du contrôleur, dans les chemins avec lesquels il est configuré : voir Modules de collections.
implicit, explicit ou smart. Voir Le cache de facts.
memory garde les facts le temps de l’exécution, jsonfile les garde d’une exécution à l’autre, et tout autre nom est un plugin Python. Voir Le cache de facts.
Le répertoire du cache jsonfile.
Nombre de secondes pendant lesquelles une entrée en cache reste fraîche. 0 n’expire jamais.
Placé devant le nom de chaque fichier de cache.
[inventory]
Section intitulée « [inventory] »Les plugins d’inventaire à essayer, dans l’ordre. Voir la chaîne de plugins.
Les extensions de fichier ignorées quand un répertoire est lu. Une valeur remplace la liste par défaut. [defaults] inventory_ignore_extensions est lu aussi.
Des expressions régulières pour les noms de fichier ignorés quand un répertoire est lu. [defaults] inventory_ignore_patterns est lu aussi.
Fait échouer l’exécution quand aucune source n’a pu être lue.
Fait échouer l’exécution dès la première source qu’aucun plugin n’a pu lire.
Fait garder à volant inventory chaque variable là où elle est définie, comme le fait --export. --export l’active pour une exécution ; rien ne le désactive depuis la ligne de commande, comme dans ansible-inventory. Voir la commande inventory.
[inventory_plugin_script]
Section intitulée « [inventory_plugin_script] »Affiche ce qu’un script d’inventaire réussi a écrit sur la sortie d’erreur sous la forme d’une ligne [ERROR]:. Avec false, seule la sortie d’erreur d’un script qui échoue est affichée.
[privilege_escalation]
Section intitulée « [privilege_escalation] »Élève les privilèges par défaut. Les mots-clés de playbook et les variables d’hôte ont priorité, voir Élévation de privilèges.
L’utilisateur vers lequel élever les privilèges.
La méthode d’élévation : sudo ou su. Les autres méthodes arrêtent l’exécution avant son début.
Le programme à lancer à la place de sudo ou de su.
Les options données à ce programme, à la place de -H pour sudo et d’aucune pour su. Une valeur vide ne donne aucune option.
[ssh_connection]
Section intitulée « [ssh_connection] »Donne un terminal à raw, à script et aux commandes qu’un plugin de module comme reboot envoie sans entrée, comme le fait ssh -tt. Réglez-le sur False quand une règle sudoers a requiretty ou qu’une commande affiche des caractères de contrôle sur un terminal. La variable d’hôte ansible_ssh_use_tty l’emporte sur la variable d’environnement, et la variable d’environnement sur le fichier. Un mot autre que y, yes, on, true, t et 1 est lu comme désactivé.
Tags sélectionnés par défaut. --tags s’ajoute à cette liste au lieu de la remplacer.
Tags ignorés par défaut. --skip-tags s’ajoute à cette liste.
[volant]
Section intitulée « [volant] »Ansible ignore cette section : un même ansible.cfg peut donc la porter et continuer à piloter les deux moteurs. ansible-config validate fait exception, voir Traitement par lots entre hôtes.
Désactivé par défaut. Avec batching = true, un hôte passe à ses tâches suivantes sans attendre les autres hôtes, sauf devant une tâche dont le texte lit un autre hôte (hostvars, ansible_play_hosts, delegate_to, un modèle ou une variable qui le fait). Une dépendance que le playbook n’écrit pas, comme un service qu’un autre hôte est encore en train d’installer ou un fichier sur un hôte nommé littéralement, n’est pas attendue. Ne l’activez que pour des plays dont les hôtes ne dépendent pas les uns des autres de cette façon. Voir Traitement par lots entre hôtes.
Laisse l’agent répondre à une tâche avec sa version native du module, quand les arguments de la tâche restent dans ce que cette version implémente. Avec false, chaque tâche passe par le module Python d’ansible-core, setup compris : c’est ainsi qu’on compare les deux chemins sur une exécution réelle. La valeur est lue comme ansible-core lit un booléen, et un mot qu’il ne connaît pas arrête l’exécution avec le code 5. Voir Modules natifs.
D’où vient le Python du contrôleur. auto utilise VOLANT_PYTHON, puis le runtime géré s’il est installé, puis l’environnement virtuel actif et python3, et installe le runtime géré quand aucun ne convient. managed n’utilise que VOLANT_PYTHON ou le runtime géré, et l’installe quand il manque. system n’utilise ni n’installe jamais le runtime géré. Tout autre mot arrête l’exécution avec le code 5. Voir Le runtime géré.
Partage une connexion OpenSSH entre tous les lancements de ssh d’un hôte de l’inventaire. Avec false, chaque lien et chaque sonde ouvrent leur propre connexion. Voir Une connexion par hôte.
Combien de rejeux propres d’affilée volant shadow status attend d’un playbook avant de le déclarer ready. Un nombre entier d’au moins 1 ; toute autre valeur arrête le run avec le code de sortie 5. Voir Changer sans risque.
La part des tâches d’un playbook que ces rejeux doivent avoir comparées, de 0 à 1, avant que volant shadow status le déclare ready. Toute autre valeur arrête le run avec le code de sortie 5.
Refuse avec le code 4 une exécution qui diffère de volant.lock, comme --locked. Désactivé, une différence donne un avertissement et l’exécution continue. Ansible ignore ce réglage avec le reste de [volant].
Définit ce que font template, copy, script, unarchive et assemble d’un src du contrôleur qu’un hôte géré a nommé, et où un fetch peut écrire un dest qu’un hôte a nommé : allow, contained ou refuse. La valeur par défaut est allow, qui se comporte comme ansible-core, et tout autre mot arrête l’exécution avec le code 5. Voir Un fichier source qu’un hôte géré a nommé pour ce que fait chaque mot.
Une liste, séparée par des deux-points, de répertoires absolus du contrôleur sous lesquels fetch peut écrire un dest qu’un hôte géré a nommé. Une entrée relative, qui utilise ~ ou .., ou qui vaut / arrête l’exécution avec le code 5. Voir Un dest qu’un hôte géré a nommé pour les règles.