Zum Inhalt springen
Installieren

volant adhoc

Führt ein Modul auf jedem Host aus, der zu einem Muster passt, mit den Optionen und der Ausgabe von ansible.

volant adhoc ist ansible: Es führt ein Modul auf jedem Host aus, der zu einem Muster passt.

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

Das auszuführende Modul. Standard: command.

Die Argumente des Moduls: key=value-Wörter oder ein JSON-Objekt, wenn der Wert mit { beginnt und mit } endet. Bei command, shell, raw und script bilden Wörter, die keine Option des Moduls sind, die Kommandozeile. Die Argumente werden mit den Variablen jedes Hosts und -e als Template gerendert. Ein Wert, der mit { beginnt, mit } endet und kein gültiges JSON ist, bricht den Befehl mit Exit-Code 250 ab; ein nicht geschlossenes Anführungszeichen bricht ihn mit Exit-Code 4 ab.

Führt die Task im Check-Modus aus. Ein Modul, das nicht prüfen kann, meldet SKIPPED.

Gibt vor dem Ergebnis die Unterschiede aus, die eine Task an Dateien und Templates vornimmt. Mit -C wird die Datei nicht geändert.

Gibt eine Zeile pro Host aus, so wie es der Callback oneline von ansible tut. ansible-core 2.19.12 markiert diese Option als veraltet und warnt auf der Standardfehlerausgabe; siehe unten.

Schreibt das Ergebnis jedes Hosts zusätzlich in eine nach dem Host benannte Datei in DIR, so wie es der Callback tree von ansible tut. ansible-core 2.19.12 markiert diese Option als veraltet und warnt auf der Standardfehlerausgabe; siehe unten.

Führt das Modul als asynchronen Job aus, der diese Zahl Sekunden zum Abschluss hat, und fragt ihn ab. Das Ergebnis enthält ansible_job_id, started, finished und results_file, und das async_val des Dictionarys Origin: ist dieser Wert. Ohne -B wird -P ignoriert.

Sekunden zwischen zwei Abfragen des Jobs von -B. Standard: 15. Mit 0 wird der Job nur gestartet, und das Ergebnis enthält "finished": false. Das poll des Dictionarys Origin: ist dieser Wert.

Lässt eine Task fehlschlagen, die länger als diese Zahl Sekunden läuft, mit Exit-Code 2 und der Meldung Task failed: Timed out after N second(s).. 0 bedeutet keine Grenze, und ein Wert über 100000000 lässt die Task mit Timeout N is invalid, it must be between 0 and 100000000. fehlschlagen. Das timeout des Dictionarys Origin: ist dieser Wert.

Gibt ansible [core 2.19.12], die Konfigurationsdatei, den Modulsuchpfad, den Ort der Collections und den Ort der ausführbaren Datei aus und hält dann an. Der Ort der ausführbaren Datei folgt argv[0]: Ein relatives argv[0] oder eines, das mit exec -a gesetzt wurde, kann eine andere Datei nennen als die, die läuft. Findet Volant einen Interpreter mit ansible-core, folgen der Ort der Module und die Versionen von Python, Jinja und PyYAML, in den Zeilen der Referenz. Ohne ihn entfallen diese Zeilen: --version installiert nichts. Die Suchpfade lesen die Umgebung und die Standardwerte, nicht library oder collections_path der ansible.cfg.

Gibt die Hosts aus, auf die das Muster passt, als hosts (2): und eine Zeile name je Host, und führt nichts aus. Der Exit-Code ist 0.

Liest group_vars/, host_vars/, relative Pfade und Rollen aus DIR und setzt playbook_dir darauf, dort, wo ein Playbook sein eigenes Verzeichnis geliefert hätte. Standard: das Arbeitsverzeichnis.

Die übrigen Optionen bedeuten das, was sie für volant playbook bedeuten, --flush-cache und -M eingeschlossen. -f 1 führt einen Host nach dem anderen aus, in der Reihenfolge des Inventorys.

Ein Muster, auf das kein Host passt, gibt [WARNING]: Could not match supplied host pattern, ignoring: PATTERN und [WARNING]: No hosts matched, nothing to do auf der Standardfehlerausgabe aus und endet mit 0. Ein -l, das keinen Host übrig lässt, gibt [ERROR]: Specified inventory, host pattern and/or --limit leaves us with no hosts to target. aus und endet mit 1, mit oder ohne --list-hosts. Eine Warnung, dass das Muster von -l nicht aufgelöst werden konnte, kommt nur davor, wenn dieses Muster auf keinen Host passt. Ein Inventory ganz ohne Host warnt einmal und führt nichts aus. Ohne Inventory ist das implizite localhost der einzige Host, und nur ein Muster, das ihn nennt, trifft ihn. Ein command, shell oder raw ohne -a bricht mit [ERROR]: No argument passed to command module und dem Exit-Code 5 ab.

Ein Aufruffehler endet mit 2. Die Standardfehlerausgabe enthält den usage:-Block von ansible, dann ansible: error: und den Grund. Auf ein fehlendes Muster oder ein -f, das keine Zahl ist, folgt die vollständige Hilfe von ansible; auf ein -f unter 1 nicht.

Jeder Host gibt ein Ergebnis aus, so wie es der minimal-Callback von ansible ausgibt. Ein Ergebnis von command, shell oder raw lautet h1 | CHANGED | rc=0 >>, dann folgen Stdout, Stderr und msg ohne Trennzeichen aneinandergehängt. Jedes andere Ergebnis lautet h1 | SUCCESS => , gefolgt vom Ergebnis als JSON, mit vier Leerzeichen eingerückt und Schlüsseln sortiert. Die Status sind SUCCESS, CHANGED, FAILED (Befehlsform), FAILED! (JSON-Form), SKIPPED und UNREACHABLE!. Vor einem fehlgeschlagenen oder nicht erreichbaren Ergebnis enthält die Standardausgabe denselben [ERROR]-Block, den ein Playbook ausgibt. Sein Origin: ist <adhoc 'MODULE' task>, gefolgt von der Task, wie ansible sie zeigt, auf 120 Zeichen gekürzt.

Der Exit-Code ist 0, wenn jeder Host erfolgreich war oder übersprungen wurde, 2, wenn ein Host fehlgeschlagen ist, und 4, wenn ein Host nicht erreicht werden konnte, ob es fehlgeschlagene Hosts gibt oder nicht. ANSIBLE_STDOUT_CALLBACK ändert die Ausgabe nur, wenn bin_ansible_callbacks eingeschaltet ist (ANSIBLE_LOAD_CALLBACK_PLUGINS=true) und es einen anderen Callback als default nennt: oneline gibt dann wie -o aus, und ein Name, den Volant nicht kennt, beendet den Befehl mit Could not load. -o hat Vorrang. Mit ANSIBLE_CALLBACK_RESULT_FORMAT=yaml oder callback_result_format = yaml unter [defaults] in der ansible.cfg wird ein Ergebnis in JSON-Form stattdessen als YAML ausgegeben, in den Zeilen nach =>, mit vier Leerzeichen eingerückt. Ein String mit Zeilenumbrüchen wird zu einem Literalblock. Jeder andere Wert, auch der leere, bricht den Befehl mit Exit-Code 5 ab.

Mit -o lautet ein Ergebnis von command, shell oder raw h1 | CHANGED | rc=0 | (stdout) hi, seine Zeilenumbrüche als \n geschrieben, und (stderr) text folgt, wenn es welchen gibt. Jedes andere Ergebnis lautet h1 | SUCCESS => und das Ergebnis als JSON in einer Zeile, Schlüssel sortiert und durch , ohne folgendes Leerzeichen getrennt. Ein Ergebnis, das die eingerückte Form verlangt, etwa debug, oder jedes Ergebnis bei -vvv, behält seine vier Leerzeichen, ohne Zeilenumbrüche. Ein fehlgeschlagener Host gibt dieselben zwei Arten von Zeilen aus, mit FAILED, und bei einem Befehl kommt zuerst die Befehlsform, dann die Zeile FAILED!. Trägt der Fehler eine Exception, kommt zuerst eine Zeile An exception occurred during task execution. To see the full traceback, use -vvv. The error was: ...; bei -vvv enthält sie den vollständigen Text. Ein nicht erreichbarer Host gibt h1 | UNREACHABLE!: und seine Meldung aus. -o gibt keinen [ERROR]-Block, keine Warnungen eines Ergebnisses und kein Diff aus und liest callback_result_format nicht. Die Exit-Codes sind dieselben wie ohne.

Mit -t DIR bleibt die Ausgabe unverändert. DIR wird angelegt, wenn das erste Ergebnis eintrifft, ~ wird aufgelöst, und ein relativer Pfad beginnt im Arbeitsverzeichnis. Jedes Ergebnis, das kein Überspringen ist, wird als JSON in einer Zeile in DIR/HOST geschrieben, Schlüssel sortiert, ohne abschließenden Zeilenumbruch, über das, was das vorige Ergebnis des Hosts hinterließ; auch ein nicht erreichbarer Host bekommt eine Datei. Ein debug-Ergebnis und jedes Ergebnis bei -vvv wird eingerückt geschrieben. Die Datei wird ersetzt, nicht an Ort und Stelle beschrieben: Ein an ihrer Stelle abgelegter Link wird ersetzt, und der Modus ist 0600. Ein Hostname, der kein einfacher Dateiname ist (leer, ., .. oder mit einem /), gibt eine [WARNING] aus und bekommt keine Datei, wo ansible-core dorthin schreibt, worauf der Name zeigt, einschließlich ../x und absoluter Pfade. Ein Verzeichnis, das sich nicht anlegen lässt, oder eine Datei, die sich nicht schreiben lässt, gibt eine [WARNING] aus, und der Lauf geht weiter. Ein $ in DIR oder ~ gefolgt von einem Benutzernamen bricht den Befehl mit Exit-Code 4 ab und sagt, dass es noch nicht unterstützt wird.

Beide Optionen geben diese Zeilen vor dem ersten Ergebnis auf der Standardfehlerausgabe aus, in dieser Reihenfolge: die [WARNING], die sagt, wie man Deprecation-Warnungen abschaltet, eine [DEPRECATION WARNING] je Option, so geschrieben und geordnet, wie die Kommandozeile sie gab (-o und -t in einer Gruppe kurzer Optionen zählen als zwei), die Warnungen des Host-Musters, dann eine [DEPRECATION WARNING] für den Callback oneline und eine für den Callback tree. Ein Lauf, der endet, bevor die Callbacks geladen werden (--list-hosts, ein -l, das keinen Host übrig lässt), gibt nur die ersten beiden Gruppen aus. deprecation_warnings = False oder ANSIBLE_DEPRECATION_WARNINGS=false unterdrückt sie alle. Bei -vv legt -o minimal beiseite, wo die Standardausgabe oneline beiseitelegt; bei -vvvv fügt -t eine Zeile für den Callback tree hinzu.

set_fact gibt seine ansible_facts wie jedes Modulergebnis aus. meta mit noop, flush_handlers, clear_facts, refresh_inventory, reset_connection oder end_host gibt nichts aus und endet mit 0, und mit end_play stoppt es mit Unexpected Exception, this is probably a bug: 0 und Exit-Code 250, wie die Referenz, ohne deren Traceback. Diese Unterschiede zu ansible-core 2.19.12 bleiben:

  • meta mit einer unbekannten Aktion oder ohne -a bricht wie die Referenz mit Exit-Code 1 ab, aber sein [ERROR]-Block endet nicht mit der Leerzeile, die die Referenz ausgibt, und ohne -a nennt er das Argument anders.
  • Das [ERROR] eines include_role oder include_tasks, das seine Rolle oder Datei nicht laden kann, ist anders formuliert. Die Exit-Codes stimmen überein: 2 für diese beiden, 1 für import_role und import_tasks.
  • group_by meldet SUCCESS mit "changed": false, wo die Referenz CHANGED meldet.

-vv beginnt mit dem Block, den --version ausgibt, dann Using PATH as config file (oder No config file found; using defaults) und die Zeilen Skipping callback 'default', as we already have a stdout callback. und Skipping callback 'oneline', as we already have a stdout callback. (minimal statt oneline mit -o). -vvv und höher fügen die Zeilen der Inventory-Plugins hinzu und die, die volant playbook ausgibt; die eigenen Zeilen ESTABLISH LOCAL CONNECTION und EXEC der Referenz beschreiben ihren Modul-Upload, den Volant nicht macht, daher werden sie nicht ausgegeben.

Ein negatives -B, -P oder --task-timeout sowie -C zusammen mit -B beenden den Befehl mit Exit-Code 4 und sagen, was noch nicht unterstützt wird. -B, -P und --task-timeout nehmen eine ganze Zahl; alles andere ist ein Aufruffehler.