mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
408e29cbd2
* fixes links on plugins pages * fixes links in community pages * fixes links in user guide * adds anchors on playbooks pages
63 lines
1.8 KiB
ReStructuredText
63 lines
1.8 KiB
ReStructuredText
.. contents:: Topics
|
|
|
|
|
|
Vars Plugins
|
|
------------
|
|
|
|
Vars plugins inject additional variable data into Ansible runs that did not come from an inventory source, playbook, or command line. Playbook constructs like 'host_vars' and 'group_vars' work using vars plugins.
|
|
|
|
Vars plugins were partially implemented in Ansible 2.0 and rewritten to be fully implemented starting with Ansible 2.4.
|
|
|
|
The :doc:`host_group_vars <vars/host_group_vars>` plugin shipped with Ansible enables reading variables from :ref:`host_vars` and :ref:`group_vars`.
|
|
|
|
|
|
.. _enable_vars:
|
|
|
|
Enabling Vars Plugins
|
|
+++++++++++++++++++++
|
|
|
|
You can activate a custom vars plugins by either dropping it into a ``vars_plugins`` directory adjacent to your play, inside a role, or by putting it in one of the directory sources configured in :ref:`ansible.cfg <ansible_configuration_settings>`.
|
|
|
|
|
|
.. _using_vars:
|
|
|
|
Using Vars Plugins
|
|
++++++++++++++++++
|
|
|
|
Vars plugins are used automatically after they are enabled.
|
|
|
|
|
|
.. _vars_plugin_list:
|
|
|
|
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 plugin-specific documentation 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
|