ansible/docs/docsite/rst/plugins/vars.rst
Brian Coca 2ed46e04f4 more updates to plugin/config generation (#30787)
* fixed module generation

added missing lookup page
point to plugins when plugins
made modules singular
add display for verbose an debug messages
nicer templating, changed generation order for ref
corrected links
moved most of lookup docs to plugin section

* Copy edits
* Fixed typos
* Clarified wording
2017-10-11 00:15:25 -04:00

1.8 KiB

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 implented in Ansible 2.0 and rewritten to be fully implemented starting with Ansible 2.4.

The host_group_vars <vars/host_group_vars> plugin shipped with Ansible enables reading variables from host_vars and 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, inside a role, or by putting it in one of the directory sources configured in ansible.cfg <../config>.

Using Vars Plugins

Vars plugins are used automatically after they are enabled.

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.

maxdepth

1

vars/*

action

Ansible Action plugins

cache

Ansible Cache plugins

callback

Ansible callback plugins

connection

Ansible connection plugins

inventory

Ansible inventory plugins

shell

Ansible Shell plugins

strategy

Ansible Strategy plugins

User Mailing List

Have a question? Stop by the google group!

irc.freenode.net

#ansible IRC chat channel