Konfiguration
Die ansible.cfg-Einstellungen und Umgebungsvariablen, die Volant liest, Abschnitt für Abschnitt und mit ihren Standardwerten.
Volant liest dieselbe ansible.cfg wie ansible-playbook und hört bei der ersten Datei auf, die es findet:
- die Datei, die
ANSIBLE_CONFIGnennt ./ansible.cfg~/.ansible.cfg/etc/ansible/ansible.cfg
Volant überspringt ./ansible.cfg, wenn das Arbeitsverzeichnis für andere Benutzer beschreibbar ist (Modusbit o+w), wie es ansible-playbook tut. Ein anderer lokaler Benutzer könnte die Datei dort abgelegt haben. Das Sticky-Bit und der Besitzer des Verzeichnisses ändern daran nichts. Volant gibt auf der Standardfehlerausgabe [WARNING]: Ansible is being run in a world writable directory (...), ignoring it as an ansible.cfg source. aus und macht mit der nächsten Datei weiter. Eine Datei, die ANSIBLE_CONFIG nennt, wird unabhängig vom Modus des Arbeitsverzeichnisses gelesen.
Für jede Einstellung schlägt die Umgebungsvariable die Datei, und die Kommandozeilenoption schlägt beide. Schlüssel, die Volant nicht verwendet, werden ignoriert, so wie Ansible die ignoriert, die es nicht verwendet.
Eine Datei, die existiert, sich aber nicht lesen lässt, wird übersprungen, und der Lauf geht mit den Standardwerten weiter. Volant gibt zuvor eine Warnung aus, was Ansible nicht tut: Eine Datei, die Sie geschrieben haben und die der Prozess nicht öffnen kann, verdient eine Zeile, und eine Warnung ändert den Exit-Code nicht.
[defaults]
Abschnitt betitelt „[defaults]“Die Inventory-Quellen als kommagetrennte Liste. Siehe Inventories.
Sekunden, die auf eine Verbindung gewartet wird. Es wird in der ssh-Kommandozeile zu ConnectTimeout.
Der Benutzer, als der angemeldet wird. Ohne ihn wählt ssh einen.
Der private Schlüssel, mit dem sich ssh authentifiziert.
Ist es an, macht ein unbekannter Host-Schlüssel den Host nicht erreichbar. Ist es aus, fügt Volant StrictHostKeyChecking=no und UserKnownHostsFile=/dev/null hinzu, sodass ein unbekannter Schlüssel akzeptiert und nicht gespeichert wird.
Das Verzeichnis auf jedem Host, das den Agent-Cache enthält.
Auf wie vielen Hosts ein Play gleichzeitig arbeitet. Null oder ein Wert, der keine Zahl ist, wird vor dem Start des Laufs abgelehnt. Playbooks lesen den aktuellen Wert als ansible_forks.
Die Strategie eines Plays, das keine nennt: linear, free, host_pinned oder debug, auch mit ansible.builtin. davor. Jeder andere Name gibt die Deprecation-Warnung von ansible-core für Strategie-Plugins außerhalb von ansible.builtin aus. Ein Plugin, das von einer dieser Strategien ableitet und nichts hinzufügt, läuft als diese Strategie, und jeder andere Name wird abgelehnt.
Das Verzeichnis auf jedem Host, das die Statusdateien von Async-Tasks enthält. ansible_async_dir hat Vorrang.
Öffnet den Debugger nach jedem fehlgeschlagenen oder nicht erreichbaren Task.
Gibt task path: <file>:<line> vor der fatal:-Zeile eines fehlgeschlagenen Tasks aus. Ab -vv folgt die Zeile ohnehin jedem Task-Banner, hier ändert es also nichts. Die failed:-Zeile eines Schleifenelements und ein nicht erreichbarer Host erhalten keine Pfadzeile. Wie in Ansible schalten y, yes, on, true, t und 1 es in jeder Schreibweise ein, und jedes andere Wort, auch eine leere Variable, lässt es aus.
Färbt die Ausgabe auch dann, wenn sie kein Terminal ist, wie CI-Logs es brauchen. Es schlägt nocolor, ANSIBLE_NOCOLOR und NO_COLOR; nur --no-color schlägt es. In einem Diff sind nur die Zeilen gefärbt, die das difflib von Ansible aus before und after gemacht hat.
Färbt die Ausgabe nie. force_color schlägt es.
Welche Ereignisse einen Traceback zeigen, als kommagetrennte Liste. Mit error oder always zeigt ein fehlgeschlagenes Python-Action-Plugin, das Fehler sammelt, etwa gather_facts mit seinen Fact-Modulen, seinen Traceback und die seiner Module und registriert ihn als exception. Jeder andere Fehler behält (traceback unavailable).
Gibt die [DEPRECATION WARNING]-Hinweise und die Zeile aus, die sagt, wie man sie abstellt. Mit False wird beides nicht ausgegeben.
Eine Bedingung, deren Ergebnis kein boolescher Wert ist, schlägt standardmäßig fehl. Mit True zählt der Wahrheitswert ihres Ergebnisses, und es wird eine [DEPRECATION WARNING] ausgegeben.
Eine Datei, an die jede Zeile angehängt wird, die der Lauf anzeigt, als ein Eintrag pro Meldung wie bei Ansible: 2026-10-30 18:34:18,430 p=<pid> u=<user> n=ansible INFO| TASK [...] ***, WARNING für ein [WARNING] und ERROR für ein [ERROR].
Die Zahl der -v, bis zu der eine Zeile in log_path landet, auch wenn der Lauf sie nicht anzeigt.
Warnt, wenn das Inventory keinen Host enthält und nur das implizite localhost übrig bleibt. all trifft diesen Host nicht.
Eine YAML-Datei, deren module_rejectlist Module nennt, die nicht benutzt werden dürfen, relativ zur Konfigurationsdatei. Ein Task, der eines davon nennt, beendet das Playbook vor dem Start an diesem Task mit couldn't resolve module/action, wie bei einem falsch geschriebenen Modul. Nur der Name so, wie die Liste ihn schreibt, wird abgelehnt: copy in der Liste lässt ansible.builtin.copy nutzbar. ansible-core 2.19.12 liest dafür keine Umgebungsvariable.
Lässt eine Rolle aus roles: oder einem import_role, das public nicht angibt, ihre defaults und vars für sich behalten. Auf false gesetzt, verleiht auch ein include_role ohne public sie. Ohne Einstellung behält nur ein include_role sie.
merge legt ein Mapping Schlüssel für Schlüssel über ein gleichnamiges Mapping, zwischen je zwei Variablenquellen und zwischen zwei Inventory-Quellen. replace behält den Wert der höheren Quelle ganz. Die Option ist in Ansible veraltet, wird dort aber noch beachtet, ohne Warnung.
Führt benachrichtigte Handler auch auf Hosts aus, die fehlgeschlagen sind.
Was ein YAML-Schlüssel bekommt, der in einer Zuordnung zweimal steht: warn behält den letzten Wert und zeigt, wo der zweite Schlüssel steht, error weist die Datei ab, ignore behält den letzten Wert ohne Meldung.
Die Fakten-Module, die das Sammeln der Fakten einer Play ausführt, smart (setup), wenn nichts gesetzt ist. Eine wörtliche Liste in den Plays, ihren Tasks oder im Inventar (ansible_facts_modules) wird ebenfalls gelesen; ein Modul, das nur ein Template nennt, kann nicht ausgeführt werden.
Das Python, unter dem ein Modul auf einem Host läuft, dessen ansible_python_interpreter nicht gesetzt ist; die Host-Variable hat Vorrang vor dieser Einstellung. auto und auto_silent suchen den Interpreter auf dem Host, und auto_silent lässt die Warnung weg, die den gefundenen nennt. auto_legacy und auto_legacy_silent verhalten sich wie auto und auto_silent und fügen die Deprecation von ansible-core hinzu. Jeder andere Wert ist der Pfad des Interpreters.
Ob from_json eine Zeichenkette mit einem einzelnen Surrogat wie \udc80 ablehnt. Ausgeschaltet behält der Wert es und wird mit ? an dessen Stelle und einer Warnung ausgegeben.
Gibt die Statistiken, die set_stats gesammelt hat, nach dem Recap aus.
Der Callback, der den Lauf ausgibt. default gibt die Banner, eine Zeile pro Ergebnis und das Recap aus. minimal gibt jedes Ergebnis so aus wie der Ad-hoc-Befehl, host | CHANGED | rc=0 >> und die Ausgabe bei einem Befehl, sonst host | SUCCESS => und das Ergebnis als JSON, ohne Banner, ohne Recap und ohne Zeile pro Schleifenelement. oneline gibt dieselben Ergebnisse je auf einer Zeile aus; ansible-core 2.19.12 markiert ihn als veraltet, und Volant gibt die Warnung einmal auf der Standardfehlerausgabe aus. tree gibt auf der Standardausgabe nichts aus. Die Namen mit ansible.builtin. funktionieren auch. yaml beendet den Lauf mit Exit-Code 1 und dem Fehler, den community.general seit 12.0.0 ausgibt, das dieses Plugin entfernt hat: callback_result_format = yaml ersetzt es. json und ansible.posix.json geben während des Laufs nichts aus und danach den ganzen Lauf als ein JSON-Dokument: jedes Play und jeden Task mit Zeiten, ID und Pfad, das Ergebnis jedes Hosts, wie der Task es geliefert hat, mit seiner action, das Recap pro Host und die set_stats-Daten, wenn show_custom_stats eingeschaltet ist. Zeichen jenseits von ASCII werden als \uXXXX geschrieben. Jeder andere Name, etwa community.general.unixy, wird über das ansible-core des Controllers geladen; einer, den es nicht findet, beendet den Lauf vor dem ersten Play mit [ERROR]: Could not load '<name>' callback plugin. und Exit-Code 1.
Wie default und minimal ein Ergebnis schreiben: json, oder yaml, wobei das Ergebnis auf den Zeilen nach => folgt, um vier Leerzeichen eingerückt, und ein Text mit Zeilenumbrüchen ein Literal-Block ist. Jeder andere Wert beendet den Lauf vor dem ersten Play mit Exit-Code 5. oneline schreibt immer JSON.
Das pretty_results von default und minimal. Nicht gesetzt, wird ein JSON-Ergebnis nur bei debug, assert und ab -vvv eingerückt, und ein YAML-Ergebnis ist hübsch. Eingeschaltet, wird jedes Ergebnis um vier Leerzeichen eingerückt. Ausgeschaltet, keines, auch kein debug. Hübsches YAML schreibt stdout_lines und stderr_lines als <omitted> neben ihren Text, verschachtelt um vier Leerzeichen und entfernt die Leerzeichen und Tabs am Ende eines Textblocks, damit er ein Block bleibt; nicht hübsches YAML lässt jeden Wert, wie er ist, und verschachtelt um zwei. Ein Wort, das kein Boolean ist, gilt als ausgeschaltet.
Leerzeichen pro Ebene im Dokument des json-Callbacks. Null oder weniger schreibt es auf eine Zeile.
Weitere Callbacks, die neben dem Stdout-Callback laufen, als kommagetrennte Liste. Volant führt junit aus, das einen JUnit-XML-Bericht pro Playbook in JUNIT_OUTPUT_DIR schreibt (standardmäßig ~/.ansible.log) und die anderen JUNIT_*-Variablen liest, tree, das das letzte Ergebnis jedes Hosts in eine Datei in [callback_tree] directory schreibt (ANSIBLE_CALLBACK_TREE_DIR, standardmäßig ~/.ansible/tree), und, wenn ansible.posix auf dem Controller installiert ist, ansible.posix.timer und ansible.posix.profile_tasks mit ihren Optionen ([callback_profile_tasks], PROFILE_TASKS_*). Jeder andere Name wird über das ansible-core des Controllers geladen; einer, den es nicht findet, gibt [WARNING]: Skipping callback plugin '<name>', unable to load aus, und der Lauf geht weiter. volant.compat.record, das die Läufe von ansible-playbook aufzeichnet, wird ohne Warnung übersprungen.
Weitere Verzeichnisse, in denen Callback-Plugins gesucht werden, durch : getrennt. Ein dort oder in callback_plugins/ neben dem Playbook gefundenes Plugin läuft über das ansible-core des Controllers in einem eigenen Python-Prozess. Ein Lauf ohne solches Plugin startet dafür kein Python.
Ob der Ad-hoc-Befehl die Callbacks oben lädt. Ausgeschaltet gibt er über minimal aus, oder mit -o über oneline, was auch immer stdout_callback sagt. Siehe den Ad-hoc-Befehl.
Eine Datei mit dem Vault-Passwort oder eine ausführbare Datei, die es ausgibt. Die Umgebungsvariable ersetzt den Wert der Datei, und die Kommandozeile ergänzt, was sich durchgesetzt hat. Siehe Vault.
Kommagetrennte Vault-Identitäten, jede als label@source geschrieben, wobei die Quelle eine Datei, eine ausführbare Datei oder prompt ist. Die Umgebungsvariable ersetzt die Liste der Datei, und die Kommandozeile ergänzt, was sich durchgesetzt hat.
Die Vault-ID, die volant vault encrypt verwendet, wenn --encrypt-vault-id nicht angegeben ist. Siehe Vault.
Der Editor, den volant vault create und edit starten. Die zuletzt gesetzte Variable gewinnt, dann die Datei, dann vi. Siehe Vault.
Wo volant vault create und edit die private Kopie aufbewahren, an der der Editor arbeitet.
Das Programm, durch das volant vault view in einem Terminal die Ausgabe leitet. Die zuletzt gesetzte Variable gewinnt, dann die Datei.
Wo nach Rollen gesucht wird, nach <playbook_dir>/roles und vor <playbook_dir> selbst. Siehe Rollen.
Wird auch als collections_paths gelesen und aus ANSIBLE_COLLECTIONS_PATHS, das ANSIBLE_COLLECTIONS_PATH schlägt. Wo nach einem dreiteiligen Rollennamen wie acme.demo.hello gesucht wird. Die Module einer Collection findet das ansible-core des Controllers in den Pfaden, mit denen es konfiguriert ist: siehe Module aus Collections.
implicit, explicit oder smart. Siehe Der Fact-Cache.
memory hält Facts für den Lauf, jsonfile hält sie zwischen Läufen, und jeder andere Name ist ein Python-Plugin. Siehe Der Fact-Cache.
Das Verzeichnis des jsonfile-Caches.
Sekunden, die ein gecachter Eintrag frisch bleibt. 0 läuft nie ab.
Wird jedem Cache-Dateinamen vorangestellt.
[inventory]
Abschnitt betitelt „[inventory]“Die Inventory-Plugins, die der Reihe nach probiert werden. Siehe die Plugin-Kette.
Dateiendungen, die beim Lesen eines Verzeichnisses übersprungen werden. Ein Wert ersetzt die Standardliste. [defaults] inventory_ignore_extensions wird ebenfalls gelesen.
Reguläre Ausdrücke für Dateinamen, die beim Lesen eines Verzeichnisses übersprungen werden. [defaults] inventory_ignore_patterns wird ebenfalls gelesen.
Lässt den Lauf fehlschlagen, wenn keine Quelle gelesen werden konnte.
Lässt den Lauf bei der ersten Quelle fehlschlagen, die kein Plugin lesen konnte.
Lässt volant inventory jede Variable dort behalten, wo sie gesetzt ist, wie es --export tut. --export schaltet es für einen Lauf ein; nichts schaltet es von der Kommandozeile aus wieder aus, wie bei ansible-inventory. Siehe der Befehl inventory.
[inventory_plugin_script]
Abschnitt betitelt „[inventory_plugin_script]“Zeigt, was ein erfolgreiches Inventory-Skript auf die Standardfehlerausgabe geschrieben hat, als Zeile [ERROR]:. Mit false wird nur die Standardfehlerausgabe eines Skripts gezeigt, das fehlschlägt.
[privilege_escalation]
Abschnitt betitelt „[privilege_escalation]“Standardmäßig die Rechte ausweiten. Keywords im Playbook und Hostvariablen haben Vorrang, siehe Rechteausweitung.
Der Benutzer, auf den die Rechte ausgeweitet werden.
Die Methode der Rechteausweitung: sudo oder su. Andere Methoden stoppen den Lauf vor dem Start.
Das Programm, das statt sudo oder su ausgeführt wird.
Die Flags, die diesem Programm übergeben werden, anstelle von -H bei sudo und von keinen bei su. Ein leerer Wert ergibt gar keine Flags.
[ssh_connection]
Abschnitt betitelt „[ssh_connection]“Gibt raw, script und den Befehlen, die ein Modul-Plugin wie reboot ohne Eingabe sendet, ein Terminal, wie es ssh -tt tut. Setzen Sie es auf False, wenn eine sudoers-Regel requiretty hat oder ein Befehl auf einem Terminal Steuerzeichen ausgibt. Die Hostvariable ansible_ssh_use_tty schlägt die Umgebungsvariable, und die Umgebungsvariable schlägt die Datei. Ein anderes Wort als y, yes, on, true, t und 1 zählt als aus.
Standardmäßig ausgewählte Tags. --tags ergänzt diese Liste, statt sie zu ersetzen.
Standardmäßig übersprungene Tags. --skip-tags ergänzt diese Liste.
[volant]
Abschnitt betitelt „[volant]“Ansible ignoriert diesen Abschnitt, sodass eine ansible.cfg ihn enthalten und trotzdem beide Engines steuern kann. ansible-config validate ist die Ausnahme, siehe Host-übergreifendes Batching.
Standardmäßig aus. Mit batching = true geht ein Host zu seinen nächsten Tasks weiter, ohne auf die anderen Hosts zu warten, außer vor einem Task, dessen Text einen anderen Host liest (hostvars, ansible_play_hosts, delegate_to, ein Template oder eine Variable, die das tut). Auf eine Abhängigkeit, die das Playbook nicht ausschreibt, etwa einen Dienst, den ein anderer Host noch installiert, oder eine Datei auf einem wörtlich genannten Host, wird nicht gewartet. Schalten Sie es nur für Plays ein, deren Hosts nicht auf diese Weise voneinander abhängen. Siehe Host-übergreifendes Batching.
Lässt den Agent einen Task mit seiner nativen Version des Moduls beantworten, wenn die Argumente des Tasks innerhalb dessen bleiben, was diese Version umsetzt. Mit false geht jeder Task an das Python-Modul von ansible-core, auch setup, so vergleichen Sie beide Pfade in einem echten Lauf. Der Wert wird so gelesen, wie ansible-core einen booleschen Wert liest, und ein Wort, das es nicht kennt, stoppt den Lauf mit Exit-Code 5. Siehe Native Module.
Woher das Python des Controllers kommt. auto verwendet VOLANT_PYTHON, dann die verwaltete Runtime, wenn installiert, dann die aktive virtuelle Umgebung und python3, und installiert die verwaltete Runtime, wenn keines davon funktioniert. managed verwendet nur VOLANT_PYTHON oder die verwaltete Runtime und installiert sie, wenn sie fehlt. system verwendet die verwaltete Runtime nie und installiert sie nie. Jedes andere Wort stoppt den Lauf mit Exit-Code 5. Siehe Die verwaltete Runtime.
Teilt eine OpenSSH-Verbindung zwischen allen ssh-Aufrufen eines Inventory-Hosts. Mit false öffnet jede Verbindung und jede Probe ihre eigene. Siehe Eine Verbindung pro Host.
Wie viele saubere Wiederholungen in Folge volant shadow status von einem Playbook erwartet, bevor es ready meldet. Eine ganze Zahl von mindestens 1; jeder andere Wert beendet den Lauf mit Exit-Code 5. Siehe Ohne Risiko umsteigen.
Der Anteil der Tasks eines Playbooks, den diese Wiederholungen verglichen haben müssen, von 0 bis 1, bevor volant shadow status ready meldet. Jeder andere Wert beendet den Lauf mit Exit-Code 5.
Lehnt einen Lauf, der von volant.lock abweicht, mit Exit 4 ab, wie --locked. Ausgeschaltet ergibt ein Unterschied eine Warnung, und der Lauf geht weiter. Ansible ignoriert die Einstellung mit dem Rest von [volant].
Legt fest, was template, copy, script, unarchive und assemble mit einem Controller-src tun, den ein verwalteter Host genannt hat, und wohin ein fetch ein dest schreiben darf, das ein Host genannt hat: allow, contained oder refuse. Der Standard ist allow, das sich wie ansible-core verhält, und jedes andere Wort stoppt den Lauf mit Exit-Code 5. Was jedes Wort bewirkt, steht unter Eine Quelldatei, die ein verwalteter Host genannt hat.
Eine durch Doppelpunkte getrennte Liste absoluter Controller-Verzeichnisse, unter denen fetch ein dest schreiben darf, das ein verwalteter Host genannt hat. Ein Eintrag, der relativ ist, ~ oder .. verwendet oder / ist, stoppt den Lauf mit Exit-Code 5. Die Regeln stehen unter Ein Ziel, das ein verwalteter Host genannt hat.