ansible/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00
Code Releases Activity

Add 'auto' to documented default enabled inventory plugins (#46621)

Browse source 
* Correct default inventory plugins enabled in docs and example/ansible.cfg

* Fix headers
This commit is contained in:
Sloane Hertel 2018-10-08 15:07:46 -04:00 committed by Alicia Cozine
parent 753711cd12
commit 43d12c11be
2 changed files with 6 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
docs/docsite/rst/plugins/inventory.rst
View file

@ -3,7 +3,7 @@
.. _inventory_plugins:
Inventory Plugins
-----------------
=================
Inventory plugins allow users to point at data sources to compile the inventory of hosts that Ansible uses to target tasks, either via the ``-i /path/to/file`` and/or ``-i 'host1, host2'`` command line parameters or from other configuration sources.
@ -11,7 +11,7 @@ Inventory plugins allow users to point at data sources to compile the inventory
.. _enabling_inventory:
Enabling Inventory Plugins
++++++++++++++++++++++++++
--------------------------
Most inventory plugins shipped with Ansible are disabled by default and need to be whitelisted in your
:ref:`ansible.cfg <ansible_configuration_settings>` file in order to function. This is how the default whitelist looks in the
@ -20,7 +20,7 @@ config file that ships with Ansible:
.. code-block:: ini
[inventory]
enable_plugins = host_list, script, yaml, ini
enable_plugins = host_list, script, yaml, ini, auto
This list also establishes the order in which each plugin tries to parse an inventory source. Any plugins left out of the list will not be considered, so you can 'optimize' your inventory loading by minimizing it to what you actually use. For example:
@ -33,7 +33,7 @@ This list also establishes the order in which each plugin tries to parse an inve
.. _using_inventory:
Using Inventory Plugins
+++++++++++++++++++++++
-----------------------
The only requirement for using an inventory plugin after it is enabled is to provide an inventory source to parse.
Ansible will try to use the list of enabled inventory plugins, in order, against each inventory source provided.
@ -107,7 +107,7 @@ If a host does not have the variables in the configuration above (i.e. ``tags.Na
.. _inventory_plugin_list:
Plugin List
+++++++++++
-----------
You can use ``ansible-doc -t inventory -l`` to see the list of available plugins.
Use ``ansible-doc -t inventory <plugin name>`` to see plugin-specific documentation and examples.

2
examples/ansible.cfg
View file

@ -324,7 +324,7 @@
#any_errors_fatal = False
[inventory]
# enable inventory plugins, default: 'host_list', 'script', 'yaml', 'ini'
# enable inventory plugins, default: 'host_list', 'script', 'yaml', 'ini', 'auto'
#enable_plugins = host_list, virtualbox, yaml, constructed
# ignore these extensions when parsing a directory as inventory source