volant inventory
Affiche un inventaire en JSON, en YAML ou en TOML, comme le fait ansible-inventory.
volant inventory affiche un inventaire en JSON, en YAML ou en TOML, comme le fait ansible-inventory. Lancée sous le nom ansible-inventory (voir la commande shims), elle se comporte de la même façon.
volant inventory (--list | --host HOST | --graph [GROUP]) [-i SOURCE]... [-l SUBSET] [-e VARS]... [--vars] [-y | --toml] [--export] [--output FILE] [-v]Exactement une des options --list, --host et --graph est requise.
Affiche chaque hôte avec ses variables, y compris celles des fichiers group_vars et host_vars et de ses groupes, puis les groupes avec leurs hosts et children. Les clés sont triées, l’indentation est de quatre espaces et le texte non ASCII est écrit tel quel. Une chaîne qui est une donnée s’affiche {"__ansible_unsafe": "..."} et une valeur !vault {"__ansible_vault": "..."} ; rien n’est déchiffré.
Affiche les variables d’un hôte. HOST est un motif d’hôte qui doit correspondre à exactement un hôte ; sinon la commande affiche You must pass a single valid host to --host parameter et sort avec le code 5. --limit ne s’applique pas.
Affiche les groupes sous forme d’arbre : @name: pour un groupe, des noms seuls pour les hôtes, les enfants d’un groupe avant ses hôtes, chaque niveau indenté de |. Avec un nom de groupe, n’affiche que ce sous-arbre. Un nom qui n’est pas un groupe affiche Pattern must be valid group name when using --graph et sort avec le code 5. --limit ne s’applique pas.
Avec --graph, ajoute des lignes {name = value} sous chaque hôte (ses variables regroupées) et chaque groupe (les siennes, fichiers group_vars compris), triées par nom et écrites avec le str() de Python. Les valeurs !vault sont déchiffrées, donc cela demande le mot de passe vault, et le texte !unsafe est affiché tel quel. Les autres actions ignorent --vars.
Affiche --list et --host en YAML, octet pour octet comme ansible-inventory. --list devient un inventaire que l’on peut relire : chaque groupe sous les children de son parent, avec ses hosts et leurs variables, clés triées. Un hôte est écrit avec ses variables la première fois que le parcours l’atteint et comme {} ensuite, un groupe déjà écrit est {}, et un groupe vide est omis. Une valeur !vault est écrite !vault | suivie de son texte chiffré, sans être déchiffrée. Le texte !unsafe est écrit en clair. --graph ignore --yaml.
Quand plusieurs hôtes reçoivent une variable du même groupe, du même fichier group_vars ou de -e, la référence ne détient qu’une valeur pour tous, et PyYAML l’écrit une fois avec une ancre (&id001) puis comme alias (*id001). Volant écrit les mêmes ancres avec les mêmes numéros. PyYAML numérote une valeur quand il la rencontre la deuxième fois, donc id001 n’est pas toujours la première ancre du fichier. Seules les listes et les mappages reçoivent des ancres.
all: children: prod: children: web: hosts: w1: list: &id001 - 1 - 2 w2: list: *id001Affiche --list et --host en TOML, dans la disposition qu’ansible-inventory affiche avec le paquet tomli-w ; Volant n’a besoin d’aucun paquet pour cela. --list a une table par groupe qui a quelque chose à montrer : [group] avec children sous forme de noms, et [group.hosts.host] avec les variables de l’hôte. Il n’y a pas de table all, et un groupe qui n’a que des hôtes n’a pas de ligne [group]. Les variables ne sont pas triées : elles viennent dans l’ordre où la référence les fusionne, celles des groupes d’abord et celles de l’hôte en dernier. Les variables d’un hôte sont écrites là où le parcours l’atteint la première fois, si bien qu’un hôte qui est dans plusieurs groupes a une table vide dans les autres. Les tableaux sont écrits un élément par ligne, avec une virgule finale et une indentation de quatre espaces. --host affiche les variables comme un document plat. --yaml l’emporte quand les deux sont donnés, et --graph ignore --toml.
Un document vide n’affiche rien et sort avec 1, comme le fait la référence. Un null ne peut pas être écrit en TOML : la commande affiche [ERROR]: Object of type 'NoneType' is not TOML serializable et sort avec 250. La référence sort aussi avec 250, avec une trace Python, que Volant ne copie pas.
Garde chaque variable là où elle est définie au lieu de fondre les variables de groupe dans chaque hôte. --list donne à chaque groupe une entrée vars avec ses propres variables et ses fichiers group_vars. Chaque hôte ne garde que ce que fixent sa ligne d’inventaire et ses fichiers host_vars ; les variables supplémentaires sont omises. Avec --yaml, aucune valeur n’est partagée, donc aucune ancre n’apparaît. Avec --host, seules les variables propres à cet hôte sont affichées. export = true dans la section [inventory] d’ansible.cfg, ou ANSIBLE_INVENTORY_EXPORT, l’active par défaut. Avec --graph --vars, les lignes d’un hôte ne montrent que ses propres variables.
Avec --list, ne garde que les hôtes qui correspondent au motif. Les groupes restent, avec leurs enfants. Un motif qui ne correspond à rien avertit et affiche un inventaire sans hôte.
L’endroit où un playbook se serait trouvé : les plugins d’inventaire et de cache des répertoires de plugins à côté de lui se chargent. ANSIBLE_PLAYBOOK_DIR le définit aussi.
Variables supplémentaires, ajoutées à chaque hôte et prioritaires sur toutes les autres couches.
Écrit le document dans FILE et n’affiche rien. Le fichier contient ce que la sortie standard aurait contenu. Un document JSON n’a pas de saut de ligne final ; un document YAML ou TOML garde le sien.
-i, -v et les options vault fonctionnent comme pour volant playbook. Sans action choisie, la commande affiche No action selected, at least one of --host, --graph or --list needs to be specified., et avec deux actions elle affiche Conflicting options used, only one of --host, --graph or --list can be used at the same time. ; les deux sortent avec le code 5.