ansible-inventory¶
None
Synopsis¶
usage: ansible-inventory [-h] [--version] [-v] [-i INVENTORY]
[--vault-id VAULT_IDS]
[--ask-vault-password | --vault-password-file VAULT_PASSWORD_FILES]
[--playbook-dir BASEDIR] [--list] [--host HOST]
[--graph] [-y] [--toml] [--vars] [--export]
[--output OUTPUT_FILE]
[host|group]
Description¶
used to display or dump the configured inventory as Ansible sees it
Common Options¶
-
--ask-vault-password
,
--ask-vault-pass
¶
ask for vault password
-
--export
¶
When doing an –list, represent in a way that is optimized for export,not as an accurate representation of how Ansible has processed it
-
--graph
¶
create inventory graph, if supplying pattern it must be a valid group name
-
--host
<HOST>
¶ Output specific host info, works as inventory script
-
--list
¶
Output all hosts info, works as inventory script
-
--list-hosts
¶
==SUPPRESS==
-
--output
<OUTPUT_FILE>
¶ When doing –list, send the inventory to a file instead of to the screen
-
--playbook-dir
<BASEDIR>
¶ Since this tool does not use playbooks, use this as a substitute playbook directory.This sets the relative path for many features including roles/ group_vars/ etc.
-
--toml
¶
Use TOML format instead of default JSON, ignored for –graph
-
--vars
¶
Add vars to graph display, ignored unless used with –graph
-
--vault-id
¶
the vault identity to use
-
--vault-password-file
,
--vault-pass-file
¶
vault password file
-
--version
¶
show program’s version number, config file location, configured module search path, module location, executable location and exit
-
-h
,
--help
¶
show this help message and exit
-
-i
,
--inventory
,
--inventory-file
¶
specify inventory host path or comma separated host list. –inventory-file is deprecated
-
-l
,
--limit
¶
==SUPPRESS==
-
-v
,
--verbose
¶
verbose mode (-vvv for more, -vvvv to enable connection debugging)
-
-y
,
--yaml
¶
Use YAML format instead of default JSON, ignored for –graph
Environment¶
The following environment variables may be specified.
ANSIBLE_CONFIG
– Override the default ansible config file
Many more are available for most options in ansible.cfg
Files¶
/etc/ansible/ansible.cfg
– Config file, used if present
~/.ansible.cfg
– User config file, overrides the default config if present