Zum Inhalt springen
Installieren

Kommandozeile

Jeder Befehl und jede Option, die Volant akzeptiert, nach ihrer Wirkung gruppiert, sowie die ansible-playbook-Optionen, die es noch nicht gibt.

Terminal-Fenster
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 --version

Jeder andere Befehl hat eine eigene Seite: 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. Ansible-Befehlsnamen verbindet sie. Diese Seite behandelt volant playbook.

volant playbook nimmt dieselben Optionen wie ansible-playbook, soweit sie dort existieren. volant-playbook ist dasselbe Programm unter einem Namen, der dem vertrauten ähnelt. Playbooks, die zusammen angegeben werden, laufen der Reihe nach, und jedes gibt seinen eigenen Recap aus.

Unter Linux und macOS richtet sich die volant-Binärdatei auch nach dem Namen, unter dem sie gestartet wurde (dem Dateinamen von argv[0]). Als ansible-playbook, ansible-vault, ansible-doc, ansible-config, ansible-galaxy, ansible-console, ansible-pull oder ansible-inventory gestartet, über einen symbolischen oder einen harten Link, verhält sie sich wie volant playbook, volant vault, volant doc, volant config, volant galaxy, volant console, volant pull oder volant inventory, mit denselben Argumenten, derselben Ausgabe und denselben Exit-Codes. Als ansible gestartet, verhält sie sich wie volant adhoc. volant doc und config führen die eigenen Werkzeuge von ansible-core aus der Python-Runtime von Volant aus. volant galaxy wird gerade nativ und lehnt jeden Unterbefehl ab, bis er es ist. volant pull und volant console sind Volants eigene Befehle; volant pull und volant console listen, worin sie abweichen. Ein Aufruffehler endet mit 2 und nennt das Programm unter dem gestarteten Namen. Jeder andere Name behält das übliche volant-Verhalten.

Hat eine Option einen Schlüssel in der ansible.cfg oder eine Umgebungsvariable, nennt der Eintrag sie. Die Option gewinnt gegen beide; Konfiguration erklärt die Reihenfolge.

Eine Inventory-Quelle: eine Datei, ein Verzeichnis, ein Skript oder eine Kommaliste von Hosts. Wiederholen Sie die Option, um mehrere zusammenzuführen, siehe Inventories. Ohne sie existiert nur das implizite localhost.

ansible.cfg
[defaults] inventory
Environment
ANSIBLE_INVENTORY

Nur auf Hosts ausführen, die zu diesem Muster passen. Ein Limit, das auf keinen Host passt, warnt und schränkt den Lauf auf das ein, worauf es gepasst hat.

Beim ersten Task mit dem Namen NAME beginnen; * und ? passen auf beliebigen Text. Die Tasks davor werden ausgelassen, außer Gathering Facts, ebenso die Plays vor dem, das ihn enthält. Gesucht wird nur in Tasks, die im Play stehen, wie bei ansible-playbook: Ein Task, den include_tasks oder include_role erst während des Laufs liest, wird nicht gefunden. Ein Name, auf den nichts passt, gibt die Plays mit leerem Recap aus, dann einen Fehler, und endet mit 0.

Vor jedem Task nachfragen: y führt ihn aus, n oder alles andere überspringt ihn, c führt ihn und jeden folgenden Task ohne Nachfrage aus. Es braucht ein Terminal; ohne eines endet der Lauf mit Exit-Code 250, bevor er einen Host berührt.

Entfernt vor dem Lauf die Einträge der Inventory-Hosts aus dem Fact-Cache.

Gibt die Volant-Version und das passende ansible-core-Release aus und endet dann.

Als dieser Benutzer an den Hosts anmelden. Ohne die Option wählt ssh den Benutzer, aus Ihrer ~/.ssh/config oder Ihrem lokalen Konto.

ansible.cfg
[defaults] remote_user
Environment
ANSIBLE_REMOTE_USER

Das Verbindungs-Plugin für Hosts, die keines nennen: ssh oder local. Das ansible_connection eines Hosts und das Keyword connection an einem Play, Block oder Task haben beide Vorrang. Jeder andere Name lässt den Task mit the connection plugin '<name>' was not found fehlschlagen.

Der private Schlüssel, mit dem sich ssh authentifiziert, als ssh -i übergeben.

ansible.cfg
[defaults] private_key_file
Environment
ANSIBLE_PRIVATE_KEY_FILE

Argumente, die jeder ssh-Kommandozeile hinzugefügt werden. Volant zerlegt sie wie eine Shell in Wörter, und ein nicht geschlossenes Anführungszeichen stoppt den Lauf vor dem Start. Die Hostvariable ansible_ssh_common_args ersetzt diesen Wert für den betreffenden Host.

Argumente, die der ssh-Kommandozeile nach den allgemeinen hinzugefügt werden. Die Hostvariable ansible_ssh_extra_args ersetzt diesen Wert für den betreffenden Host.

Wie lange auf eine Verbindung gewartet wird, als ConnectTimeout an ssh übergeben.

Default
10
ansible.cfg
[defaults] timeout
Environment
ANSIBLE_TIMEOUT

Auf wie vielen Hosts ein Play gleichzeitig arbeitet. Null oder ein Wert, der keine Zahl ist, wird vor dem Start des Laufs abgelehnt.

Default
5
ansible.cfg
[defaults] forks
Environment
ANSIBLE_FORKS

Verzeichnisse, in denen vor den konfigurierten nach Modulen gesucht wird. Durch Doppelpunkte getrennt und wiederholbar. Ein späteres -M kommt vor ein früheres.

Extra-Variablen, an der Spitze der Rangfolge: key=value-Paare, Inline-JSON oder -YAML oder @file. Wiederholbar.

Nur Tasks mit diesen Tags ausführen. Durch Kommas getrennt und wiederholbar, und zum konfigurierten Standard hinzugefügt, statt ihn zu ersetzen. Siehe Tags.

ansible.cfg
[tags] run
Environment
ANSIBLE_RUN_TAGS

Tasks mit diesen Tags überspringen. Durch Kommas getrennt und wiederholbar, und zum konfigurierten Standard hinzugefügt.

ansible.cfg
[tags] skip
Environment
ANSIBLE_SKIP_TAGS

Diese Optionen lesen die Playbooks und halten an. Sie verbinden sich nie mit einem Host und halten nie an einem nicht unterstützten Modul an, sodass sie auch für Playbooks funktionieren, die dieses Release noch nicht ausführen kann.

Listet die Tasks auf, die der Lauf ausführen würde, im Format von Ansible.

Listet die Tags auf, die der Lauf auswählen würde.

Listet die Hosts auf, auf denen jedes Play laufen würde, in Inventory-Reihenfolge.

Lädt und kompiliert die Playbooks, ohne etwas auszuführen.

Tasks mit Rechteausweitung ausführen. Ein become-Keyword im Playbook entscheidet weiterhin für sein eigenes Play, seinen Block oder Task. Siehe Rechteausweitung.

Default
false
ansible.cfg
[privilege_escalation] become
Environment
ANSIBLE_BECOME

Der Benutzer, auf den die Rechte ausgeweitet werden.

Default
root
ansible.cfg
[privilege_escalation] become_user
Environment
ANSIBLE_BECOME_USER

Die Methode der Rechteausweitung: sudo oder su. Andere Methoden stoppen den Lauf vor dem Start.

Default
sudo
ansible.cfg
[privilege_escalation] become_method
Environment
ANSIBLE_BECOME_METHOD

Fragt das SSH-Passwort im Terminal ab, ohne Echo. ssh erhält es über SSH_ASKPASS, daher braucht es OpenSSH 8.4 oder neuer. Das Passwort steht in keiner Kommandozeile, keiner an den Host gesendeten Umgebung und keinem Log. Nach -k verwendet eine leere Antwort auf die Abfrage von -K das SSH-Passwort wieder, wie bei ansible-playbook.

Liest das SSH-Passwort aus der ersten Zeile dieser Datei. Es steht im Konflikt mit -k.

Liest das Passwort für die Rechteausweitung aus der ersten Zeile dieser Datei. Es steht im Konflikt mit -K.

Fragt das Passwort für die Rechteausweitung im Terminal ab, ohne Echo. Das Passwort wird einmal an sudo geschrieben und erscheint in keiner Kommandozeile, keinem Log und keinem Ergebnis.

Fragt das Vault-Passwort im Terminal ab, ohne Echo.

Eine Datei mit dem Vault-Passwort oder eine ausführbare Datei, die es ausgibt. Wiederholbar.

ansible.cfg
[defaults] vault_password_file
Environment
ANSIBLE_VAULT_PASSWORD_FILE

Eine Vault-Identität: Die Quelle ist eine Datei, eine ausführbare Datei oder prompt. Wiederholbar. Jedes Passwort wird bei jedem verschlüsselten Wert versucht, unabhängig von seinem Label. Siehe Vault.

ansible.cfg
[defaults] vault_identity_list
Environment
ANSIBLE_VAULT_IDENTITY_LIST

Führt benachrichtigte Handler auch auf Hosts aus, die fehlgeschlagen sind. Ein Keyword force_handlers am Play hat Vorrang. Siehe Handler.

Default
false
ansible.cfg
[defaults] force_handlers
Environment
ANSIBLE_FORCE_HANDLERS

Meldet, was jeder Task ändern würde, ohne etwas zu ändern. Das eigene Keyword check_mode eines Tasks gewinnt gegen diese Option, sodass ein Task mit check_mode: false trotzdem echt läuft. Ein Host ohne Python kann bei --check oder --diff weder apt, user, group noch file beantworten: Diese Module brauchen es, und der Task schlägt fehl. Siehe Check-Modus, Diff und Auflistungen.

Default
false

Gibt die Änderungen aus, die Module an Dateien vornehmen, so wie es ansible-playbook tut. Das eigene Keyword diff eines Tasks gewinnt gegen diese Option, sodass diff: false die Änderungen eines Tasks vom Bildschirm fernhält. Ein Host ohne Python kann bei --diff weder apt, user, group noch file beantworten: Diese Module brauchen es, und der Task schlägt fehl. Siehe Check-Modus, Diff und Auflistungen.

Default
false

Zeigt auch bei erfolgreichen Tasks die Modulergebnisse. Wiederholbar, wie -vvv bei Ansible. Ein Ergebnis trägt seinen Schlüssel invocation, die Argumente, die das Modul erhalten hat, erst ab -vvv. Bei -vvvv gibt der Lauf zusätzlich jede Option aus, die er erhalten hat, die Plugins, die er lädt, und die ssh-Befehle, die er ausführt.

Gibt ohne Farben aus. Die Option schlägt force_color (ANSIBLE_FORCE_COLOR), das nocolor schlägt. Siehe Konfiguration.

ansible.cfg
[defaults] nocolor
Environment
ANSIBLE_NOCOLOR

Woher gesammelte Facts kommen. auto verwendet das native setup des Agents, wenn jeder Fact, den die Plays lesen können, einer ist, den er liefert, und sonst das Modul setup von ansible-core. python führt immer das Python-Modul aus, zum Vergleich. native fragt immer den Collector des Agents, und Facts, die er nicht liefert, sind dann nicht definiert. Auf einem anderen Host als Debian oder Ubuntu gibt der native Collector den Task an das Python-Modul zurück, was auch diese Option sagt. Siehe Facts.

Default
auto

Lehnt den Lauf vor jeder Verbindung mit Exit 4 ab, wenn installierte Collections, Rollen, Runtime oder Volant von volant.lock abweichen. Ohne die Option ergibt jeder Unterschied eine Warnung.

Gibt nach dem Recap auf der Standardfehlerausgabe aus, wohin die Zeit des Laufs ging: die Phasen des Controllers pro Host, dann für jedes Modul den Pfad, den seine Tasks genommen haben (native, python oder fallback), ihre Zeiten und warum ein natives Modul einen Task zurückgegeben hat. Die erste Zeile sagt, woher die Facts kamen und warum.

Volant liest die oben genannten ANSIBLE_*-Variablen sowie einige eigene.

Der Python-Interpreter, den der Controller zum Bau von Modul-Payloads verwendet. Er braucht ansible-core. Ist er gesetzt, verwendet Volant nur ihn und installiert nichts. Welchen Interpreter ein Lauf verwendet nennt die vollständige Reihenfolge.

Ob Volant sein eigenes Python verwenden und installieren darf. Siehe Die verwaltete Runtime.

ansible.cfg
[volant] runtime

Ein Verzeichnis mit den Agent-Binärdateien. Es wird zuerst geprüft, vor den im Release-Controller eingebauten Agents und dem Verzeichnis der ausführbaren Datei volant. Nützlich bei einem aus dem Quellcode gebauten Controller oder um einen eigenen Agent zu testen.

ansible.cfg
[volant] batching

Wie ein Controller-src behandelt wird, den ein verwalteter Host genannt hat. Siehe host_named_paths.

ansible.cfg
[volant] host_named_paths

Die Controller-Verzeichnisse, unter denen ein fetch schreiben darf, wenn ein verwalteter Host sein dest genannt hat. Siehe host_named_dest_dirs.

ansible.cfg
[volant] host_named_dest_dirs

Mit 0 führt jeder Task das Python-Modul von ansible-core aus statt der nativen Version des Agents. Siehe Native Module.

ansible.cfg
[volant] native_modules

Mit 0 öffnet jeder ssh-Aufruf seine eigene Verbindung, statt eine pro Inventory-Host zu teilen.

ansible.cfg
[volant] ssh_control_master

Schreibt das Profil des Laufs in diese Datei, ein JSON-Objekt pro Zeile: zuerst die nativen Module, die jeder Agent gemeldet hat, dann die Phasen, dann eine Zeile pro Task mit Modul, Pfad, Rückgabegrund und Zeiten in Mikrosekunden. Sie wird unabhängig davon geschrieben, was aus dem Lauf wurde, und eine Datei, die sich nicht schreiben lässt, gibt nur eine Warnung aus.

Jede ansible-playbook-Option wird akzeptiert. --scp-extra-args und --sftp-extra-args haben keine Wirkung, weil Dateien über die Agent-Verbindung übertragen werden. Die Paritätsseite führt jede Option mit ihrem Status auf.

volant hat die Unterbefehle playbook, adhoc, check, inventory, runtime, lock, shadow, shims, compat, vault, doc, config, galaxy, console und pull. Es gibt kein volant lint; nutzen Sie dafür ansible-lint. volant check sagt, ob Volant ein Playbook ausführen kann. Das ist nicht --check, das das Playbook im Prüfmodus gegen Hosts ausführt.