ansible.builtin.auto inventory – Loads and executes an inventory plugin specified in a YAML config
Note
This inventory plugin is part of ansible-core
and included in all Ansible
installations. In most cases, you can use the short
plugin name
auto
even without specifying the collections:
keyword.
However, we recommend you use the FQCN for easy linking to the
plugin documentation and to avoid conflicting with other collections that may have
the same inventory plugin name.
New in version 2.5: of ansible.builtin
Synopsis
By enabling the
auto
inventory plugin, any YAML inventory config file with aplugin
key at its root will automatically cause the named plugin to be loaded and executed with that config. This effectively provides automatic enabling of all installed/accessible inventory plugins.To disable this behavior, remove
auto
from theINVENTORY_ENABLED
config element.
Examples
# This plugin is not intended for direct use; it is a fallback mechanism for automatic enabling of
# all installed inventory plugins.
Authors
Matt Davis (@nitzmahone)
Hint
Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up.