volant adhoc
Exécute un module sur chaque hôte qui correspond à un motif, avec les options et la sortie d'ansible.
volant adhoc est ansible : il exécute un module sur chaque hôte qui correspond à un motif.
volant adhoc <PATTERN> [-m MODULE] [-a ARGS] [-i INV] [-e VARS] [-l SUBSET] [-f N] [-u USER] [-c CONN] [-T SECS] [-b --become-user --become-method -K --become-password-file] [-k --connection-password-file] [--private-key --ssh-common-args --ssh-extra-args] [-J --vault-id --vault-password-file] [-M PATH] [--list-hosts] [--flush-cache] [--playbook-dir DIR] [-C] [-D] [-o] [-t DIR] [-B SECONDS] [-P SECONDS] [--task-timeout SECONDS] [--version] [-v]Le module à exécuter. Par défaut : command.
Les arguments du module : des mots key=value, ou un objet JSON quand la valeur commence par { et finit par }. Pour command, shell, raw et script, les mots qui ne sont pas une option du module forment la ligne de commande. Les arguments sont rendus comme modèles avec les variables de chaque hôte et -e. Une valeur qui commence par {, finit par } et n’est pas du JSON valide arrête la commande avec le code de sortie 250 ; un guillemet non fermé l’arrête avec le code 4.
Exécute la tâche en mode check. Un module qui ne sait pas vérifier signale SKIPPED.
Affiche, avant son résultat, les différences qu’une tâche apporte aux fichiers et aux modèles. Avec -C, le fichier n’est pas modifié.
Affiche une ligne par hôte, comme le fait le callback oneline d’ansible. ansible-core 2.19.12 déprécie cette option et avertit sur l’erreur standard ; voir plus bas.
Écrit aussi le résultat de chaque hôte dans un fichier de DIR nommé d’après l’hôte, comme le fait le callback tree d’ansible. ansible-core 2.19.12 déprécie cette option et avertit sur l’erreur standard ; voir plus bas.
Exécute le module comme un job asynchrone qui dispose de ce nombre de secondes pour finir, et l’interroge. Le résultat porte ansible_job_id, started, finished et results_file, et le async_val du dictionnaire Origin: vaut cette valeur. Sans -B, -P est ignoré.
Secondes entre deux consultations du job de -B. Par défaut : 15. Avec 0, le job est seulement démarré, et le résultat porte "finished": false. Le poll du dictionnaire Origin: vaut cette valeur.
Fait échouer une tâche qui dure plus de ce nombre de secondes, avec le code de sortie 2 et le message Task failed: Timed out after N second(s).. 0 signifie aucune limite, et une valeur supérieure à 100000000 fait échouer la tâche avec Timeout N is invalid, it must be between 0 and 100000000.. Le timeout du dictionnaire Origin: vaut cette valeur.
Affiche ansible [core 2.19.12], le fichier de configuration, le chemin de recherche des modules, l’emplacement des collections et l’emplacement de l’exécutable, puis s’arrête. L’emplacement de l’exécutable suit argv[0] : un argv[0] relatif, ou fixé avec exec -a, peut désigner un autre fichier que celui qui s’exécute. Quand Volant trouve un interpréteur avec ansible-core, l’emplacement des modules et les versions de Python, Jinja et PyYAML suivent, dans les lignes de la référence. Sans interpréteur, ces lignes sont omises : --version n’installe rien. Les chemins de recherche lisent l’environnement et les valeurs par défaut, pas library ni collections_path d’ansible.cfg.
Affiche les hôtes que le motif désigne, sous la forme hosts (2): puis une ligne nom par hôte, et n’exécute rien. Le code de sortie est 0.
Lit group_vars/, host_vars/, les chemins relatifs et les rôles depuis DIR, et y fixe playbook_dir, là où un playbook aurait fourni son propre répertoire. Par défaut : le répertoire courant.
Les autres options ont le sens qu’elles ont pour volant playbook, --flush-cache et -M compris. -f 1 exécute un hôte à la fois, dans l’ordre de l’inventaire.
Un motif qui ne désigne aucun hôte affiche [WARNING]: Could not match supplied host pattern, ignoring: PATTERN et [WARNING]: No hosts matched, nothing to do sur l’erreur standard, et sort avec 0. Un -l qui ne laisse aucun hôte affiche [ERROR]: Specified inventory, host pattern and/or --limit leaves us with no hosts to target. et sort avec 1, avec ou sans --list-hosts. Un avertissement disant que le motif de -l n’a pu être résolu vient avant, seulement quand ce motif ne désigne aucun hôte. Un inventaire sans aucun hôte avertit une fois et n’exécute rien. Sans inventaire, le localhost implicite est le seul hôte qui existe, et seul un motif qui le nomme le désigne. Un command, shell ou raw lancé sans -a s’arrête avec [ERROR]: No argument passed to command module et le code de sortie 5.
Une erreur d’usage sort avec 2. L’erreur standard porte le bloc usage: d’ansible, puis ansible: error: et la raison. Un motif manquant ou un -f qui n’est pas un nombre est suivi de l’aide complète d’ansible ; un -f inférieur à 1 ne l’est pas.
Chaque hôte affiche un résultat, comme le fait le callback minimal d’ansible. Un résultat de command, shell ou raw est h1 | CHANGED | rc=0 >>, puis sa sortie standard, son erreur standard et son msg collés sans rien entre eux. Tout autre résultat est h1 | SUCCESS => suivi du résultat en JSON, indenté de quatre espaces, clés triées. Les statuts sont SUCCESS, CHANGED, FAILED (forme commande), FAILED! (forme JSON), SKIPPED et UNREACHABLE!. Avant un résultat en échec ou injoignable, la sortie standard porte le même bloc [ERROR] qu’affiche un playbook. Son Origin: est <adhoc 'MODULE' task>, suivi de la tâche telle qu’ansible la montre, coupée à 120 caractères.
Le code de sortie est 0 quand chaque hôte a réussi ou a été ignoré, 2 quand un hôte a échoué, et 4 quand un hôte n’a pas pu être joint, qu’il y ait ou non des hôtes en échec. ANSIBLE_STDOUT_CALLBACK ne change la sortie que si bin_ansible_callbacks est activé (ANSIBLE_LOAD_CALLBACK_PLUGINS=true) et qu’il nomme un autre callback que default : oneline affiche alors comme -o, et un nom que Volant n’a pas arrête la commande avec Could not load. -o l’emporte. Avec ANSIBLE_CALLBACK_RESULT_FORMAT=yaml, ou callback_result_format = yaml sous [defaults] dans ansible.cfg, un résultat de forme JSON est affiché en YAML à la place, sur les lignes après =>, indenté de quatre espaces. Une chaîne avec des sauts de ligne devient un bloc littéral. Toute autre valeur, la valeur vide comprise, arrête la commande avec le code de sortie 5.
Une ligne par hôte
Section intitulée « Une ligne par hôte »Avec -o, un résultat de command, shell ou raw est h1 | CHANGED | rc=0 | (stdout) hi, ses sauts de ligne écrits \n, suivi de (stderr) text quand il y en a. Tout autre résultat est h1 | SUCCESS => et le résultat en JSON sur une ligne, clés triées et séparées par , sans espace après. Un résultat qui demande la forme indentée, comme debug, ou tout résultat à -vvv, garde ses quatre espaces, sauts de ligne retirés. Un hôte en échec affiche les deux mêmes sortes de ligne, avec FAILED, et pour une commande la forme commande vient d’abord, puis la ligne FAILED!. Quand l’échec porte une exception, une ligne An exception occurred during task execution. To see the full traceback, use -vvv. The error was: ... vient en premier ; à -vvv elle contient le texte complet. Un hôte injoignable affiche h1 | UNREACHABLE!: et son message. -o n’affiche ni bloc [ERROR], ni avertissements d’un résultat, ni diff, et ne lit pas callback_result_format. Les codes de sortie sont les mêmes que sans lui.
Avec -t DIR, la sortie ne change pas. DIR est créé à l’arrivée du premier résultat, ~ est développé, et un chemin relatif part du répertoire de travail. Chaque résultat qui n’est pas ignoré est écrit dans DIR/HOST en JSON sur une ligne, clés triées, sans saut de ligne final, par-dessus ce que le résultat précédent de l’hôte a laissé ; un hôte injoignable a aussi un fichier. Un résultat de debug, et tout résultat à -vvv, est écrit indenté. Le fichier est remplacé, pas écrit en place : un lien posé à son emplacement est remplacé, et le mode est 0600. Un nom d’hôte qui n’est pas un simple nom de fichier (vide, ., .., ou contenant un /) affiche un [WARNING] et n’obtient aucun fichier, là où ansible-core écrit où le nom pointe, ../x et les chemins absolus compris. Un répertoire qui ne peut pas être créé, ou un fichier qui ne peut pas être écrit, affiche un [WARNING] et l’exécution continue. Un $ dans DIR, ou un ~ suivi d’un nom d’utilisateur, arrête la commande avec le code de sortie 4 et dit que ce n’est pas encore pris en charge.
Les deux options affichent ces lignes sur l’erreur standard avant le premier résultat, dans cet ordre : le [WARNING] qui dit comment désactiver les avertissements de dépréciation, un [DEPRECATION WARNING] par option, écrit et ordonné comme la ligne de commande l’a donné (-o et -t dans un même groupe d’options courtes comptent pour deux), les avertissements du motif d’hôte, puis un [DEPRECATION WARNING] pour le callback oneline et un pour le callback tree. Une exécution qui se termine avant le chargement des callbacks (--list-hosts, un -l qui ne laisse aucun hôte) n’affiche que les deux premiers groupes. deprecation_warnings = False ou ANSIBLE_DEPRECATION_WARNINGS=false les fait tous taire. À -vv, -o met minimal de côté, là où la sortie par défaut met oneline de côté ; à -vvvv, -t ajoute une ligne pour le callback tree.
Les actions qui ne sont pas des modules
Section intitulée « Les actions qui ne sont pas des modules »set_fact affiche ses ansible_facts comme tout résultat de module. meta avec noop, flush_handlers, clear_facts, refresh_inventory, reset_connection ou end_host n’affiche rien et sort avec 0, et avec end_play il s’arrête sur Unexpected Exception, this is probably a bug: 0 et le code de sortie 250, comme la référence, sans sa trace. Ces différences avec ansible-core 2.19.12 subsistent :
metaavec une action inconnue, ou sans-a, s’arrête avec le code de sortie 1 comme la référence, mais son bloc[ERROR]ne se termine pas par la ligne vide qu’affiche la référence, et sans-ail nomme l’argument autrement.- Le
[ERROR]d’uninclude_roleou d’uninclude_tasksqui ne peut pas charger son rôle ou son fichier est formulé autrement. Les codes de sortie concordent : 2 pour ces deux-là, 1 pourimport_roleetimport_tasks. group_bysignaleSUCCESSavec"changed": falselà où la référence signaleCHANGED.
Sortie verbeuse
Section intitulée « Sortie verbeuse »-vv ouvre par le bloc qu’affiche --version, puis Using PATH as config file (ou No config file found; using defaults), et les lignes Skipping callback 'default', as we already have a stdout callback. et Skipping callback 'oneline', as we already have a stdout callback. (minimal au lieu de oneline avec -o). -vvv et plus ajoutent les lignes des plugins d’inventaire et celles qu’affiche volant playbook ; les lignes ESTABLISH LOCAL CONNECTION et EXEC de la référence décrivent son envoi de module, que Volant ne fait pas, elles ne sont donc pas affichées.
Un -B, -P ou --task-timeout négatif, et -C avec -B, arrêtent la commande avec le code de sortie 4 et disent ce qui n’est pas encore pris en charge. -B, -P et --task-timeout prennent un nombre entier ; toute autre valeur est une erreur d’usage.