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. However, we recommend you use the Fully Qualified Collection Name (FQCN) ansible.builtin.auto for easy linking to the plugin documentation and to avoid conflicting with other collections that may have the same inventory plugin name.

Synopsis

  • By enabling the auto inventory plugin, any YAML inventory config file with a plugin 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 the INVENTORY_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)

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/ansible/builtin/auto_inventory.html