diff options
| author | Michael DeHaan <michael.dehaan@gmail.com> | 2012-11-26 18:47:33 -0500 |
|---|---|---|
| committer | Michael DeHaan <michael.dehaan@gmail.com> | 2012-11-26 18:47:33 -0500 |
| commit | 21d858f36da9198e0349223b37c1c4c82cb492ed (patch) | |
| tree | 3297c7cc9907c86713058faf95a82018c8d3e20d | |
| parent | da90c5f75e4db5c92092fe8dc39d2169557b0a45 (diff) | |
| download | ansible-21d858f36da9198e0349223b37c1c4c82cb492ed.tar.gz | |
Document new types of plugins.
| -rw-r--r-- | docsite/rst/api.rst | 16 |
1 files changed, 15 insertions, 1 deletions
diff --git a/docsite/rst/api.rst b/docsite/rst/api.rst index 5ca2b56124..a901c86b72 100644 --- a/docsite/rst/api.rst +++ b/docsite/rst/api.rst @@ -303,7 +303,19 @@ directory. Lookup Plugins -------------- -Language constructs like "with_fileglob" are implemnted via lookup plugins. Just like other plugin types, you can write your own. +Language constructs like "with_fileglob" and "with_items" are implemented via lookup plugins. Just like other plugin types, you can write your own. + +Vars Plugins +------------ + +Playbook constructs like 'host_vars' and 'group_vars' work via 'vars' plugins. They inject additional variable +data into ansible runs that did not come from an inventory, playbook, or command line. Note that variables +can also be returned from inventory, so in most cases, you won't need to write or understand vars_plugins. + +Filter Plugins +-------------- + +If you want more Jinja2 filters available in a Jinja2 template (filters like to_yaml and to_json are provided by default), they can be extended by writing a filter plugin. Distributing Plugins -------------------- @@ -317,6 +329,8 @@ to /usr/share/ansible/plugins, in a subfolder for each plugin type:: * lookup_plugins * callback_plugins * connection_plugins + * filter_plugins + * vars_plugins To change this path, edit the ansible configuration file. |