Ligne de commande
Chaque commande et option que Volant accepte, regroupées selon ce qu'elles changent, et les options d'ansible-playbook qu'il n'a pas encore.
volant playbook [OPTIONS] <PLAYBOOK>...volant-playbook [OPTIONS] <PLAYBOOK>...volant adhoc [OPTIONS] <PATTERN>volant config [ARGS...]volant console [pattern] [OPTIONS]volant doc [ARGS...]volant galaxy [ARGS...]volant pull -U URL [OPTIONS] [PLAYBOOK...]volant inventory (--list | --host HOST) [OPTIONS]volant runtime <install|pack|status|path|remove>volant shadow replay RECORDING [--json]volant compat install [-p PATH] [-f]volant lock [--check]volant shims <install|remove>volant vault <encrypt|decrypt|view|create|edit|rekey|encrypt_string>volant --versionChaque autre commande a sa propre page : volant adhoc, volant check, volant config, volant compat, volant console, volant doc, volant galaxy, volant pull, volant inventory, volant lock, volant runtime, volant shadow, volant shims, volant vault. Les noms des commandes ansible les relie. Cette page décrit volant playbook.
volant playbook accepte les mêmes options qu’ansible-playbook, pour celles qui existent. volant-playbook est le même programme sous un nom qui ressemble à celui que vous connaissez. Les playbooks donnés ensemble s’exécutent dans l’ordre, et chacun affiche son propre récapitulatif.
Sous Linux et macOS, le binaire volant choisit aussi son comportement d’après le nom sous lequel il a été lancé (le nom de fichier de argv[0]). Lancé comme ansible-playbook, ansible-vault, ansible-doc, ansible-config, ansible-galaxy, ansible-console, ansible-pull ou ansible-inventory, par un lien symbolique ou un lien physique, il se comporte comme volant playbook, volant vault, volant doc, volant config, volant galaxy, volant console, volant pull ou volant inventory, avec les mêmes arguments, la même sortie et les mêmes codes de sortie. Lancé comme ansible, il se comporte comme volant adhoc. volant doc et config lancent les propres outils d’ansible-core depuis le runtime Python de Volant. volant galaxy devient natif et refuse chaque sous-commande tant qu’elle ne l’est pas. volant pull et volant console sont propres à Volant ; volant pull et volant console listent en quoi ils diffèrent. Une erreur d’usage sort avec 2 et nomme le programme tel qu’il a été lancé. Tout autre nom garde le comportement habituel de volant.
Quand une option a une clé d’ansible.cfg ou une variable d’environnement, l’entrée la nomme. L’option l’emporte sur les deux ; Configuration explique l’ordre.
Hôtes et connexions
Section intitulée « Hôtes et connexions »Une source d’inventaire : un fichier, un répertoire, un script ou une liste d’hôtes séparés par des virgules. Répétez l’option pour en fusionner plusieurs, voir Inventaires. Sans elle, seul le localhost implicite existe.
N’exécute que sur les hôtes qui correspondent à ce motif. Une limite qui ne correspond à aucun hôte avertit et restreint l’exécution à ce qui a correspondu.
Démarre à la première tâche nommée NAME ; * et ? correspondent à n’importe quel texte. Les tâches qui la précèdent sont écartées, Gathering Facts mis à part, tout comme les plays qui précèdent celui qui la contient. Seules les tâches écrites dans le play sont cherchées, comme dans ansible-playbook : une tâche qu’un include_tasks ou un include_role lit pendant l’exécution n’est pas trouvée. Un nom que rien ne reconnaît affiche les plays avec un récapitulatif vide, puis une erreur, et sort avec 0.
Demande avant chaque tâche : y l’exécute, n ou toute autre réponse l’ignore, c l’exécute ainsi que toutes les suivantes sans demander. Il faut un terminal ; sans terminal, l’exécution s’arrête avec le code de sortie 250 avant de toucher un hôte.
Supprime avant l’exécution les entrées du cache de facts des hôtes de l’inventaire.
Affiche la version de Volant et la version d’ansible-core à laquelle elle correspond, puis s’arrête.
Se connecte aux hôtes sous cet utilisateur. Sans lui, ssh choisit l’utilisateur, d’après votre ~/.ssh/config ou votre compte local.
Le plugin de connexion des hôtes qui n’en nomment aucun : ssh ou local. L’ansible_connection d’un hôte et le mot-clé connection d’un play, d’un bloc ou d’une tâche l’emportent tous deux sur lui. Tout autre nom fait échouer la tâche avec the connection plugin '<name>' was not found.
La clé privée avec laquelle ssh s’authentifie, passée sous la forme ssh -i.
Arguments ajoutés à chaque ligne de commande ssh. Volant les découpe en mots comme le ferait un shell, et un guillemet non fermé arrête l’exécution avant son début. La variable d’hôte ansible_ssh_common_args remplace cette valeur pour cet hôte.
Arguments ajoutés à la ligne de commande ssh après les arguments communs. La variable d’hôte ansible_ssh_extra_args remplace cette valeur pour cet hôte.
Combien de temps attendre une connexion, passé à ssh sous la forme ConnectTimeout.
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.
Répertoires où chercher des modules avant ceux qui sont configurés. Séparés par des deux-points et répétables. Un -M plus tardif passe devant un -M plus ancien.
Variables et tags
Section intitulée « Variables et tags »Variables supplémentaires, tout en haut de l’ordre de priorité : paires key=value, JSON ou YAML en ligne, ou @file. Répétable.
N’exécute que les tâches qui portent ces tags. Séparés par des virgules et répétables, et ajoutés à la valeur par défaut configurée au lieu de la remplacer. Voir Tags et listes.
Ignore les tâches qui portent ces tags. Séparés par des virgules et répétables, et ajoutés à la valeur par défaut configurée.
Regarder sans exécuter
Section intitulée « Regarder sans exécuter »Ces options lisent les playbooks puis s’arrêtent. Elles ne se connectent jamais à un hôte et ne s’arrêtent jamais sur un module non pris en charge : elles fonctionnent donc sur des playbooks que cette version ne peut pas encore exécuter.
Liste les tâches que l’exécution lancerait, dans le format d’Ansible.
Liste les tags que l’exécution sélectionnerait.
Liste les hôtes sur lesquels chaque play s’exécuterait, dans l’ordre de l’inventaire.
Charge et compile les playbooks sans rien exécuter.
Élévation de privilèges
Section intitulée « Élévation de privilèges »Exécute les tâches avec élévation de privilèges. Un mot-clé become du playbook décide toujours pour son propre play, bloc ou tâche. 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.
Demande le mot de passe SSH sur le terminal, avec l’écho désactivé. ssh le reçoit par SSH_ASKPASS : il faut donc OpenSSH 8.4 ou plus récent. Le mot de passe n’est dans aucune ligne de commande, aucun environnement envoyé à l’hôte et aucun journal. Après -k, une réponse vide à l’invite de -K réutilise le mot de passe SSH, comme dans ansible-playbook.
Lit le mot de passe SSH sur la première ligne de ce fichier. Il est incompatible avec -k.
Lit le mot de passe d’élévation sur la première ligne de ce fichier. Il est incompatible avec -K.
Demande le mot de passe d’élévation sur le terminal, avec l’écho désactivé. Le mot de passe est écrit une seule fois dans sudo et n’apparaît dans aucune ligne de commande, aucun journal ni aucun résultat.
Demande le mot de passe vault sur le terminal, avec l’écho désactivé.
Un fichier qui contient le mot de passe vault, ou un exécutable qui l’affiche. Répétable.
Une identité vault : la source est un fichier, un exécutable ou prompt. Répétable. Chaque mot de passe est essayé sur chaque valeur chiffrée, quel que soit son label. Voir Vault.
Exécution et sortie
Section intitulée « Exécution et sortie »Exécute les handlers notifiés même sur les hôtes qui ont échoué. Un mot-clé force_handlers sur le play a priorité. Voir Handlers.
Indique ce que chaque tâche changerait sans rien changer. Le mot-clé check_mode propre à une tâche l’emporte sur cette option : une tâche avec check_mode: false s’exécute donc pour de vrai. Un hôte sans Python ne peut pas répondre à apt, user, group ni file sous --check ou --diff : ces modules en ont besoin, et la tâche échoue. Voir Mode check et diff.
Affiche les changements que les modules apportent aux fichiers, comme le fait ansible-playbook. Le mot-clé diff propre à une tâche l’emporte sur cette option : diff: false garde donc les changements d’une tâche hors de l’écran. Un hôte sans Python ne peut pas répondre à apt, user, group ni file sous --diff : ces modules en ont besoin, et la tâche échoue. Voir Mode check et diff.
Affiche aussi les résultats de module pour les tâches réussies. Répétable, comme le -vvv d’Ansible. Un résultat ne porte sa clé invocation, les arguments que le module a reçus, qu’à partir de -vvv. À -vvvv, l’exécution affiche aussi chaque option qu’elle a reçue, les plugins qu’elle charge et les commandes ssh qu’elle lance.
Affiche sans couleurs. L’option l’emporte sur force_color (ANSIBLE_FORCE_COLOR), qui l’emporte sur nocolor. Voir Configuration.
D’où viennent les facts collectés. auto utilise le setup natif de l’agent quand chaque fact que les plays peuvent lire est un fact qu’il produit, et le module setup d’ansible-core sinon. python exécute toujours le module Python, pour comparer. native interroge toujours le collecteur de l’agent, et les facts qu’il ne produit pas sont alors indéfinis. Sur un hôte autre que Debian ou Ubuntu, le collecteur natif rend la tâche au module Python quelle que soit cette option. Voir Facts.
Refuse l’exécution avec le code 4, avant toute connexion, quand les collections, rôles, runtime ou Volant installés diffèrent de volant.lock. Sans lui, chaque différence donne un avertissement.
Après le récapitulatif, affiche sur la sortie d’erreur où est passé le temps de l’exécution : les phases du contrôleur par hôte, puis, pour chaque module, le chemin qu’ont pris ses tâches (native, python ou fallback), leurs durées, et pourquoi un module natif a rendu une tâche. La première ligne dit d’où venaient les facts et pourquoi.
Variables d’environnement
Section intitulée « Variables d’environnement »Volant lit les variables ANSIBLE_* citées plus haut, plus quelques-unes qui lui sont propres.
L’interpréteur Python que le contrôleur utilise pour construire les charges utiles des modules. Il a besoin d’ansible-core. Quand elle est définie, Volant n’utilise que lui et n’installe rien. Quel interpréteur une exécution utilise donne l’ordre complet.
Si Volant peut utiliser et installer son propre Python. Voir Le runtime géré.
Un répertoire qui contient les binaires de l’agent. Il est vérifié en premier, avant les agents intégrés au contrôleur de la version publiée et le répertoire de l’exécutable volant. Utile avec un contrôleur compilé depuis les sources, ou pour tester un agent de votre cru.
Comment est traité un src du contrôleur qu’un hôte géré a nommé. Voir host_named_paths.
Les répertoires du contrôleur sous lesquels un fetch peut écrire quand un hôte géré a nommé son dest. Voir host_named_dest_dirs.
Avec 0, chaque tâche exécute le module Python d’ansible-core au lieu de la version native de l’agent. Voir Modules natifs.
Avec 0, chaque lancement de ssh ouvre sa propre connexion au lieu d’en partager une par hôte de l’inventaire.
Écrit le profil de l’exécution dans ce fichier, un objet JSON par ligne : les modules natifs que chaque agent a signalés, puis les phases, puis une ligne par tâche avec son module, son chemin, la raison du renvoi et ses durées en microsecondes. Il est écrit quel que soit le sort de l’exécution, et un fichier qui ne peut pas être écrit n’affiche qu’un avertissement.
Pas encore disponible
Section intitulée « Pas encore disponible »Toutes les options d’ansible-playbook sont acceptées. --scp-extra-args et --sftp-extra-args n’ont aucun effet, parce que les fichiers circulent sur le lien de l’agent. La page de parité liste chaque option avec son statut.
volant a les sous-commandes playbook, adhoc, check, inventory, runtime, lock, shadow, shims, compat, vault, doc, config, galaxy, console et pull. Il n’y a pas de volant lint : lancez ansible-lint pour cela. volant check dit si Volant peut exécuter un playbook. Ce n’est pas --check, qui exécute le playbook en mode vérification sur les hôtes.