mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
b233f3f296
* updated docs - for devs: - added inventory/vars section - made some updates to general section and other plugin types - for users: - added 'user' plugin section to start describing the plugins - docs on types, what they are and how to use - removed ref to deleted AUTHORS file - corrected several typos/headers - added descriptions to config.rst template - ignore generated files for cli/plugins and config - remove new generated files on `make clean` - moved details from devguid and intro doc to plugin specific pages - pretied up lookup notes - changed precedence ref to not conflict config - removed duplicate config data, as config is autogenerated and up to date - put new plugins under playbooks - added `pass` cause rst/python dislikes fractions - removed dupe in .gitignore, alpha sorted to avoid moar dupes - added try cause rst/python freaks out * generate plugins into their own dir only do plugins that support docs use toctree from main plugins page
48 lines
1.4 KiB
ReStructuredText
48 lines
1.4 KiB
ReStructuredText
.. contents:: Topics
|
|
|
|
|
|
Vars Plugins
|
|
------------
|
|
|
|
They inject additional variable data into ansible runs that did not come from an inventory source, playbook, or command line.
|
|
The :doc:`host_group_vars <vars/host_group_vars>` plugin shipped with Ansible provides reading variables from :ref:`host_vars` and :ref:`group_vars`.
|
|
|
|
|
|
Enabling Vars Plugins
|
|
+++++++++++++++++++++
|
|
|
|
You can activate a custom vars plugins by either dropping it into a ``vars_plugins`` directory adjacent to your play or inside a role
|
|
or by putting it in one of the directory sources configured in :doc:`ansible.cfg <../config>`.
|
|
|
|
Plugin Lists
|
|
++++++++++++
|
|
|
|
You can use ``ansible-doc -t vars -l`` to see the list of available plugins,
|
|
use ``ansible-doc -t vars <plugin name>`` to see specific documents and examples.
|
|
|
|
|
|
.. toctree:: :maxdepth: 1
|
|
:glob:
|
|
|
|
vars/*
|
|
|
|
.. seealso::
|
|
|
|
:doc:`action`
|
|
Ansible Action plugins
|
|
:doc:`cache`
|
|
Ansible Cache plugins
|
|
:doc:`callback`
|
|
Ansible callback plugins
|
|
:doc:`connection`
|
|
Ansible connection plugins
|
|
:doc:`inventory`
|
|
Ansible inventory plugins
|
|
:doc:`shell`
|
|
Ansible Shell plugins
|
|
:doc:`strategy`
|
|
Ansible Strategy plugins
|
|
`User Mailing List <http://groups.google.com/group/ansible-devel>`_
|
|
Have a question? Stop by the google group!
|
|
`irc.freenode.net <http://irc.freenode.net>`_
|
|
#ansible IRC chat channel
|