ansible.builtin.auto – Loads and executes an inventory plugin specified in a YAML config

Note

This module is part of ansible-base and included in all Ansible installations. In most cases, you can use the short module name auto even without specifying the collections: keyword. Despite that, we recommend you use the FQCN for easy linking to the module documentation and to avoid conflicting with other collections that may have the same module name.

New in version 2.5: of ansible.builtin

Synopsis

  • By whitelisting 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 whitelisting 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 whitelisting of
# all installed inventory plugins.

Authors

  • Matt Davis (@nitzmahone)

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