ansible/docs/docsite/rst/plugins/plugins.rst

********************
Working With Plugins
********************

Plugins are pieces of code that augment Ansible's core functionality. Ansible uses a plugin architecture to enable a rich, flexible and expandable feature set.

Ansible ships with a number of handy plugins, and you can easily write your own.

This section covers the various types of plugins that are included with Ansible:

.. toctree:: 
   :maxdepth: 1

   action
   cache
   callback
   connection
   inventory
   lookup
   shell
   strategy
   vars
   playbooks_filters
   playbooks_tests
   ../user_guide/plugin_filtering_config

.. seealso::

   :doc:`playbooks`
       An introduction to playbooks
   :doc:`config`
       Ansible configuration documentation and settings
   :doc:`command_line_tools`
       Ansible tools, description and options
   `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
Core Docs Refactor and Redesign (#36067) * Docs refactor as outlined in https://github.com/ansible/proposals/issues/79. Moves content into 'guides'; refactors TOC; fixes CSS; design tweaks to layout and CSS; fixes generated plugin, CLI and module docs to fix links accodingly; more. * Adding extra blank line for shippable 2018-02-13 16:23:55 +01:00			`********************`
			`Working With Plugins`
			`********************`
updated plugin docs (#30490) * 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 2017-09-23 05:19:50 +02:00
Core Docs Refactor and Redesign (#36067) * Docs refactor as outlined in https://github.com/ansible/proposals/issues/79. Moves content into 'guides'; refactors TOC; fixes CSS; design tweaks to layout and CSS; fixes generated plugin, CLI and module docs to fix links accodingly; more. * Adding extra blank line for shippable 2018-02-13 16:23:55 +01:00			`Plugins are pieces of code that augment Ansible's core functionality. Ansible uses a plugin architecture to enable a rich, flexible and expandable feature set.`
Plugin doc update edits for #30490 (#30889) * Edit pass 1 for #30490 - command line tools and developing plugins. * Continuing edit pass for #30490. WIP * Last round of copy edits for #30490. 2017-09-26 00:37:33 +02:00
updated plugin docs (#30490) * 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 2017-09-23 05:19:50 +02:00			`Ansible ships with a number of handy plugins, and you can easily write your own.`

Plugin doc update edits for #30490 (#30889) * Edit pass 1 for #30490 - command line tools and developing plugins. * Continuing edit pass for #30490. WIP * Last round of copy edits for #30490. 2017-09-26 00:37:33 +02:00			`This section covers the various types of plugins that are included with Ansible:`
updated plugin docs (#30490) * 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 2017-09-23 05:19:50 +02:00
Core Docs Refactor and Redesign (#36067) * Docs refactor as outlined in https://github.com/ansible/proposals/issues/79. Moves content into 'guides'; refactors TOC; fixes CSS; design tweaks to layout and CSS; fixes generated plugin, CLI and module docs to fix links accodingly; more. * Adding extra blank line for shippable 2018-02-13 16:23:55 +01:00			`.. toctree::`
			`:maxdepth: 1`

			`action`
			`cache`
			`callback`
			`connection`
			`inventory`
			`lookup`
			`shell`
			`strategy`
			`vars`
			`playbooks_filters`
			`playbooks_tests`
			`../user_guide/plugin_filtering_config`
updated plugin docs (#30490) * 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 2017-09-23 05:19:50 +02:00
			`.. seealso::`

			:doc:`playbooks`
			`An introduction to playbooks`
			:doc:`config`
			`Ansible configuration documentation and settings`
			:doc:`command_line_tools`
			`Ansible tools, description and options`
			`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`