跳转到内容
安装

volant inventory

以 JSON、YAML 或 TOML 打印 inventory,与 ansible-inventory 一样。

volant inventory 以 JSON、YAML 或 TOML 打印 inventory,与 ansible-inventory 一样。以 ansible-inventory 的名字启动时(见 shims 命令),行为相同。

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

--list、--host 和 --graph 必须恰好给出一个。

打印每台主机及其变量(已合并 group_vars 和 host_vars 文件以及所属组的变量),然后是各个组及其 hosts 和 children。键按字母顺序排序,缩进为四个空格,非 ASCII 文本按原样写出。属于数据的字符串打印为 {"__ansible_unsafe": "..."},!vault 值打印为 {"__ansible_vault": "..."};不会解密任何内容。

打印一台主机的变量。HOST 是主机模式,必须恰好匹配一台主机,否则命令打印 You must pass a single valid host to --host parameter 并以退出码 5 结束。--limit 不适用。

以树的形式打印各个组:组写作 @name:,主机只写名字,组的子组排在它的主机之前,每一层缩进 |。给出组名时,只打印该子树。不是组的名字会打印 Pattern must be valid group name when using --graph 并以退出码 5 结束。--limit 不适用。

与 --graph 一起使用时,在每台主机(其合并后的变量)和每个组(它自己的变量,包括 group_vars 文件)下面加上 {name = value} 行,按名字排序,用 Python 的 str() 写出。!vault 值会被解密,所以需要 vault 密码,!unsafe 文本按原样打印。其他动作会忽略 --vars。

把 --list 和 --host 以 YAML 打印,字节与 ansible-inventory 一致。--list 成为可以读回的 inventory:每个组位于其父组的 children 之下,带有它的 hosts 及其变量,键已排序。主机在遍历第一次到达时连同变量写出,之后写作 {};已经写过的组是 {},空组被省略。!vault 值写作 !vault | 加其密文,不会解密。!unsafe 文本按普通文本写出。--graph 忽略 --yaml。

当多台主机从同一个组、同一个 group_vars 文件或 -e 得到同一个变量时,参考实现中它们共用一个值,PyYAML 会先用锚点(&id001)写出一次,之后写作别名(*id001)。Volant 写出相同的锚点和相同的编号。PyYAML 在第二次遇到某个值时才给它编号,所以 id001 不一定是文件中的第一个锚点。只有列表和映射会有锚点。

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

把 --list 和 --host 以 TOML 打印,布局与 ansible-inventory 借助 tomli-w 包打印的一致;Volant 为此不需要任何包。--list 为每个有内容可显示的组提供一张表:[group],其中 children 是名字列表;以及带有主机变量的 [group.hosts.host]。没有 all 表,只有主机的组也没有 [group] 行。变量不排序:它们按参考实现合并的顺序出现,先是组的变量,最后是主机自己的。主机的变量写在遍历第一次到达它的位置,所以属于多个组的主机在其他组中是一张空表。数组每个元素占一行,带结尾逗号和四个空格的缩进。--host 把变量打印成一个平铺的文档。两者同时给出时 --yaml 优先,--graph 忽略 --toml。

没有任何内容的文档什么也不打印,并以 1 退出,与参考实现一致。null 无法写成 TOML:命令会打印 [ERROR]: Object of type 'NoneType' is not TOML serializable 并以 250 退出。参考实现也以 250 退出,并带有 Python 回溯,Volant 不复制它。

让每个变量保留在它被设置的地方,而不是把组变量合并进每台主机。--list 给每个组一个 vars 条目,包含它自己的变量和它的 group_vars 文件。每台主机只保留它的 inventory 行和 host_vars 文件所设置的内容;额外变量被省略。与 --yaml 一起使用时不共用任何值,所以不会出现锚点。与 --host 一起使用时,只打印该主机自己的变量。ansible.cfg 的 [inventory] 小节中的 export = true,或 ANSIBLE_INVENTORY_EXPORT,会默认开启它。与 --graph --vars 一起使用时,主机的行只显示它自己的变量。

与 --list 一起使用时,只保留匹配该模式的主机。组仍然保留,连同其子组。没有匹配任何内容的模式会发出警告,并打印一个没有主机的 inventory。

playbook 本应所在的位置:它旁边的插件目录中的 inventory 和 cache 插件会被加载。ANSIBLE_PLAYBOOK_DIR 也可以设置它。

额外变量,加到每台主机上,优先于其他所有层。

把文档写入 FILE,不打印任何内容。文件内容与标准输出相同。JSON 文档末尾没有换行;YAML 或 TOML 文档保留它的最后一个换行。

-i、-v 和 vault 选项的用法与 volant playbook 相同。没有选择动作时,命令打印 No action selected, at least one of --host, --graph or --list needs to be specified.;给出两个动作时打印 Conflicting options used, only one of --host, --graph or --list can be used at the same time.;两者都以退出码 5 结束。