Documentation

ansible-inventory

None

Synopsis

ansible-inventory [options] [host|group]

Description

used to display or dump the configured inventory as Ansible sees it

Common Options

--ask-vault-pass

ask for vault password

--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

outputs a list of matching hosts; does not execute anything else

--playbook-dir <BASEDIR>

Since this tool does not use playbooks, use this as a subsitute playbook directory.This sets the relative path for many features including roles/ group_vars/ etc.

--vars

Add vars to graph display, ignored unless used with --graph

--vault-id

the vault identity to use

--vault-password-file

vault password file

--version

show program's version number 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 <SUBSET>, --limit <SUBSET>

further limit selected hosts to an additional pattern

-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

Author

Ansible was originally written by Michael DeHaan.

See the AUTHORS file for a complete list of contributors.

See also

ansible(1), ansible-config(1), ansible-console(1), ansible-doc(1), ansible-galaxy(1), ansible-inventory(1), ansible-playbook(1), ansible-pull(1), ansible-vault(1),

Read the Docs v: stable
Versions
latest
stable
Downloads
On Read the Docs
Project Home
Builds

Free document hosting provided by Read the Docs.