Zum Inhalt springen
Installieren

volant inventory

Gibt ein Inventory als JSON, YAML oder TOML aus, so wie es ansible-inventory tut.

volant inventory gibt ein Inventory als JSON, YAML oder TOML aus, so wie es ansible-inventory tut. Unter dem Namen ansible-inventory gestartet (siehe der Befehl shims), verhält er sich genauso.

volant inventory (--list | --host HOST | --graph [GROUP]) [-i SOURCE]... [-l SUBSET] [-e VARS]... [--vars] [-y | --toml] [--export] [--output FILE] [-v]

Genau eine der Optionen --list, --host und --graph ist erforderlich.

Gibt jeden Host mit seinen Variablen aus, einschließlich der Dateien group_vars und host_vars und der Variablen seiner Gruppen, dann die Gruppen mit ihren hosts und children. Die Schlüssel sind sortiert, die Einrückung beträgt vier Leerzeichen, und Nicht-ASCII-Text wird unverändert geschrieben. Ein String, der Daten ist, wird als {"__ansible_unsafe": "..."} ausgegeben und ein !vault-Wert als {"__ansible_vault": "..."}; nichts wird entschlüsselt.

Gibt die Variablen eines Hosts aus. HOST ist ein Host-Muster, das genau einen Host treffen muss, sonst gibt der Befehl You must pass a single valid host to --host parameter aus und endet mit Exit-Code 5. --limit gilt nicht.

Gibt die Gruppen als Baum aus: @name: für eine Gruppe, reine Namen für Hosts, die Kinder einer Gruppe vor ihren Hosts, jede Ebene um | eingerückt. Mit einem Gruppennamen wird nur dieser Teilbaum ausgegeben. Ein Name, der keine Gruppe ist, gibt Pattern must be valid group name when using --graph aus und endet mit Exit-Code 5. --limit gilt nicht.

Fügt mit --graph Zeilen {name = value} unter jedem Host (seine zusammengeführten Variablen) und jeder Gruppe (ihre eigenen, einschließlich der Dateien group_vars) hinzu, nach Namen sortiert und mit str() von Python geschrieben. !vault-Werte werden entschlüsselt, dafür ist das Vault-Passwort nötig, und !unsafe-Text wird unverändert ausgegeben. Die anderen Aktionen ignorieren --vars.

Gibt --list und --host als YAML aus, Byte für Byte wie ansible-inventory. --list wird zu einem Inventory, das sich zurücklesen lässt: jede Gruppe unter den children ihres Elternteils, mit ihren hosts und deren Variablen, Schlüssel sortiert. Ein Host wird beim ersten Erreichen durch den Durchlauf mit seinen Variablen geschrieben und danach als {}, eine bereits geschriebene Gruppe ist {}, und eine leere Gruppe entfällt. Ein !vault-Wert wird als !vault | und sein Chiffretext geschrieben, ohne entschlüsselt zu werden. !unsafe-Text wird als einfacher Text geschrieben. --graph ignoriert --yaml.

Erhalten mehrere Hosts eine Variable aus derselben Gruppe, derselben group_vars-Datei oder aus -e, hält die Referenz einen Wert für alle, und PyYAML schreibt ihn einmal mit einem Anker (&id001) und danach als Alias (*id001). Volant schreibt dieselben Anker mit denselben Nummern. PyYAML nummeriert einen Wert, wenn es ihm zum zweiten Mal begegnet, daher ist id001 nicht immer der erste Anker in der Datei. Nur Listen und Mappings erhalten Anker.

all:
children:
prod:
children:
web:
hosts:
w1:
list: &id001
- 1
- 2
w2:
list: *id001

Gibt --list und --host als TOML aus, im Layout, das ansible-inventory mit dem Paket tomli-w ausgibt; Volant braucht dafür kein Paket. --list hat eine Tabelle pro Gruppe, die etwas zu zeigen hat: [group] mit children als Namen und [group.hosts.host] mit den Variablen des Hosts. Es gibt keine Tabelle all, und eine Gruppe, die nur Hosts hat, hat keine Zeile [group]. Variablen sind nicht sortiert: Sie kommen in der Reihenfolge, in der die Referenz sie zusammenführt, zuerst die der Gruppen und zuletzt die des Hosts. Die Variablen eines Hosts werden dort geschrieben, wo der Durchlauf ihn zuerst erreicht, sodass ein Host in mehreren Gruppen in den anderen eine leere Tabelle hat. Arrays werden mit einem Element pro Zeile, einem abschließenden Komma und vier Leerzeichen Einrückung geschrieben. --host gibt die Variablen als flaches Dokument aus. --yaml gewinnt, wenn beide angegeben sind, und --graph ignoriert --toml.

Ein Dokument ohne Inhalt gibt nichts aus und endet mit 1, wie es die Referenz tut. Ein null lässt sich in TOML nicht schreiben: Der Befehl gibt [ERROR]: Object of type 'NoneType' is not TOML serializable aus und endet mit 250. Die Referenz endet ebenfalls mit 250, mit einem Python-Traceback, den Volant nicht nachahmt.

Behält jede Variable dort, wo sie gesetzt ist, statt Gruppenvariablen in jeden Host einzurechnen. --list gibt jeder Gruppe einen Eintrag vars mit ihren eigenen Variablen und ihren group_vars-Dateien. Jeder Host behält nur, was seine Inventory-Zeile und seine host_vars-Dateien setzen; zusätzliche Variablen entfallen. Mit --yaml wird kein Wert geteilt, also erscheinen keine Anker. Mit --host werden nur die eigenen Variablen dieses Hosts ausgegeben. export = true im Abschnitt [inventory] der ansible.cfg oder ANSIBLE_INVENTORY_EXPORT schaltet es standardmäßig ein. Mit --graph --vars zeigen die Zeilen eines Hosts nur seine eigenen Variablen.

Behält mit --list nur die Hosts, die zum Muster passen. Gruppen bleiben, mit ihren Kindern. Ein Muster ohne Treffer warnt und gibt ein Inventory ohne Host aus.

Wo ein Playbook gelegen hätte: Inventory- und Cache-Plugins aus den Plugin-Verzeichnissen daneben werden geladen. ANSIBLE_PLAYBOOK_DIR setzt es ebenfalls.

Zusätzliche Variablen, jedem Host hinzugefügt und stärker als jede andere Ebene.

Schreibt das Dokument nach FILE und gibt nichts aus. Die Datei enthält, was die Standardausgabe enthalten hätte. Ein JSON-Dokument hat keinen abschließenden Zeilenumbruch; ein YAML- oder TOML-Dokument behält seinen.

-i, -v und die Vault-Optionen funktionieren wie bei volant playbook. Ohne gewählte Aktion gibt der Befehl No action selected, at least one of --host, --graph or --list needs to be specified. aus, bei zwei Aktionen Conflicting options used, only one of --host, --graph or --list can be used at the same time.; beide enden mit Exit-Code 5.