ansible-inventory - Show Ansible inventory information, by default it uses the inventory script JSON format
usage: ansible-inventory [-h] [--version] [-v] [-i INVENTORY]
[--vault-id VAULT_IDS] [--ask-vault-password | --vault-password-file VAULT_PASSWORD_FILES] [--playbook-dir BASEDIR] [-e EXTRA_VARS] [--list] [--host HOST] [--graph] [-y] [--toml] [--vars] [--export] [--output OUTPUT_FILE] [host|group]
used to display or dump the configured inventory as Ansible sees it
ask for vault password
When doing an --list, represent in a way that is optimized for export,not as an accurate representation of how Ansible has processed it
create inventory graph, if supplying pattern it must be a valid group name
Output specific host info, works as inventory script
Output all hosts info, works as inventory script
When doing --list, send the inventory to a file instead of to the screen
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.
Use TOML format instead of default JSON, ignored for --graph
Add vars to graph display, ignored unless used with --graph
the vault identity to use
vault password file
show program's version number, config file location, configured module search path, module location, executable location and exit
set additional variables as key=value or YAML/JSON, if filename prepend with @
show this help message and exit
-i, --inventory, --inventory-file
specify inventory host path or comma separated host list. --inventory-file is deprecated
Causes Ansible to print more debug messages. Adding multiple -v will increase the verbosity, the builtin plugins currently evaluate up to -vvvvvv. A reasonable level to start is -vvv, connection debugging might require -vvvv.
Use YAML format instead of default JSON, ignored for --graph
The name of a host to match in the inventory, relevant when using --list
The name of a group in the inventory, relevant when using --graph
Ansible stores the hosts it can potentially operate on in an inventory. This can be an YAML file, ini-like file, a script, directory, list, etc. For additional options, see the documentation on https://docs.ansible.com/.
The following environment variables may be specified.
ANSIBLE_INVENTORY -- Override the default ansible inventory sources
ANSIBLE_CONFIG -- Specify override location for the ansible config file
Many more are available for most options in ansible.cfg
For a full list check https://docs.ansible.com/. or use the ansible-config command.
/etc/ansible/hosts -- Default inventory file
/etc/ansible/ansible.cfg -- Config file, used if present
~/.ansible.cfg -- User config file, overrides the default config if present
./ansible.cfg -- Local config file (in current working directory) assumed to be 'project specific' and overrides the rest if present.
As mentioned above, the ANSIBLE_CONFIG environment variable will override all others.
Ansible was originally written by Michael DeHaan.
Copyright © 2018 Red Hat, Inc | Ansible. Ansible is released under the terms of the GPLv3 license.
ansible (1), ansible-config (1), ansible-console (1), ansible-doc (1), ansible-galaxy (1), ansible-playbook (1), ansible-pull (1), ansible-vault (1)
Extensive documentation is available in the documentation site: <- https://docs.ansible.com>. IRC and mailing list info can be found in file CONTRIBUTING.md, available in: <- https://github.com/ansible/ansible>