ansible/docs/docsite/rst/plugins/vars.rst
Alicia Cozine e700309618
Refine plugin docs (#49324)
* local TOCs, anchors, better headings, :ref:-not-:doc: links on all plugin pages
2018-11-29 14:03:00 -06:00

1.9 KiB

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 host_group_vars <host_group_vars_vars> plugin shipped with Ansible enables reading variables from host_variables and group_variables.

Enabling vars plugins

You can activate a custom vars plugin 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 <ansible_configuration_settings>.

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_plugins

Ansible Action plugins

cache_plugins

Ansible Cache plugins

callback_plugins

Ansible callback plugins

connection_plugins

Ansible connection plugins

inventory_plugins

Ansible inventory plugins

shell_plugins

Ansible Shell plugins

strategy_plugins

Ansible Strategy plugins

User Mailing List

Have a question? Stop by the google group!

irc.freenode.net

#ansible IRC chat channel