ansible/docs/docsite/rst/user_guide/modules.rst

.. _working_with_modules:

Working With Modules
====================

.. toctree::
   :maxdepth: 1

   modules_intro
   ../reference_appendices/common_return_values
   modules_support
   ../modules/modules_by_category


Ansible ships with a number of modules (called the 'module library')
that can be executed directly on remote hosts or through :ref:`Playbooks <working_with_playbooks>`.

Users can also write their own modules. These modules can control system resources,
like services, packages, or files (anything really), or handle executing system commands.


.. seealso::

   :ref:`intro_adhoc`
       Examples of using modules in /usr/bin/ansible
   :ref:`playbooks_intro`
       Introduction to using modules with /usr/bin/ansible-playbook
   :ref:`developing_modules_general`
       How to write your own modules
   :ref:`developing_api`
       Examples of using modules with the Python API
   :ref:`interpreter_discovery`
       Configuring the right Python interpreter on target hosts
   `Mailing List <https://groups.google.com/group/ansible-project>`_
       Questions? Help? Ideas?  Stop by the list on Google Groups
   `irc.freenode.net <http://irc.freenode.net>`_
       #ansible IRC chat channel
Doc build warning/broken link clean-a-palooza (#37382) * Doc build warning/broken link clean-a-palooza, WIP commit 1. * Fixed broken anchor * Fixing additional broken links; converting from doc to ref. * Fix anchor 2018-03-14 20:44:21 +01:00			`.. _working_with_modules:`

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 Modules`
			`====================`
Docs updates 2012-03-08 19:36:47 +01:00
Split content into subpages. 2013-12-25 00:05:41 +01:00			`.. toctree::`
moar docs added docs for new v2 features restructures modules bar and core/extras info into their own pages changed templates to refer to the new pages added some missing ansible.cfg options more info on gathering setting 2015-07-17 19:53:13 +02:00			`:maxdepth: 1`
Split content into subpages. 2013-12-25 00:05:41 +01:00
moar docs added docs for new v2 features restructures modules bar and core/extras info into their own pages changed templates to refer to the new pages added some missing ansible.cfg options more info on gathering setting 2015-07-17 19:53:13 +02:00			`modules_intro`
Fixes more rST errors (#39042) * removes include, avoids duplicate label rST warnings * reduces literal_block errors on playbooks_filters * addresses TOC errors * ref error on modules page * trying ref for list_of_database_modules 2018-04-20 02:02:48 +02:00			`../reference_appendices/common_return_values`
Doc module meta (#20093) * updated module docs to reflect unification/meta * new doc page * also remove module refs to old core/extra * Update modules_support.rst Light edit. 2017-01-10 21:58:22 +01:00			`modules_support`
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			`../modules/modules_by_category`
More exciting anchor tags, document more loop features! 2013-10-05 00:34:39 +02:00
Add auto-gen TOCs to a bunch of pages. 2012-08-28 21:41:10 +02:00
Fixing the MySQL docs 2012-08-03 17:31:43 +02:00			`Ansible ships with a number of modules (called the 'module library')`
removes last :doc: links in user guide (#58433) * removes last :doc: links in user guide 2019-06-26 23:07:27 +02:00			that can be executed directly on remote hosts or through :ref:`Playbooks <working_with_playbooks>`.
Further modifications to the module formatter to adjust to the new theme, and some misc docs text corrections. 2013-12-25 19:23:58 +01:00
moar docs added docs for new v2 features restructures modules bar and core/extras info into their own pages changed templates to refer to the new pages added some missing ansible.cfg options more info on gathering setting 2015-07-17 19:53:13 +02:00			`Users can also write their own modules. These modules can control system resources,`
			`like services, packages, or files (anything really), or handle executing system commands.`
Minor docs restructuring 2012-03-08 19:53:48 +01:00
Move see also blocks to bottom of each page to include reading docs, remove 'fork me' to avoid text overlap, simply menu nav so folks find the chapter link. 2012-03-31 15:29:31 +02:00
			`.. seealso::`

removes last :doc: links in user guide (#58433) * removes last :doc: links in user guide 2019-06-26 23:07:27 +02:00			:ref:`intro_adhoc`
doc fixes 2012-04-13 00:20:52 +02:00			`Examples of using modules in /usr/bin/ansible`
removes last :doc: links in user guide (#58433) * removes last :doc: links in user guide 2019-06-26 23:07:27 +02:00			:ref:`playbooks_intro`
			`Introduction to using modules with /usr/bin/ansible-playbook`
			:ref:`developing_modules_general`
link module dev guide from modules page 2012-03-31 16:21:28 +02:00			`How to write your own modules`
removes last :doc: links in user guide (#58433) * removes last :doc: links in user guide 2019-06-26 23:07:27 +02:00			:ref:`developing_api`
Move see also blocks to bottom of each page to include reading docs, remove 'fork me' to avoid text overlap, simply menu nav so folks find the chapter link. 2012-03-31 15:29:31 +02:00			`Examples of using modules with the Python API`
removes last :doc: links in user guide (#58433) * removes last :doc: links in user guide 2019-06-26 23:07:27 +02:00			:ref:`interpreter_discovery`
Python interpreter discovery (#50163) * Python interpreter discovery * No longer blindly default to only `/usr/bin/python` * `ansible_python_interpreter` defaults to `auto_legacy`, which will discover the platform Python interpreter on some platforms (but still favor `/usr/bin/python` if present for backward compatibility). Use `auto` to always use the discovered interpreter, append `_silent` to either value to suppress warnings. * includes new doc utility method `get_versioned_doclink` to generate a major.minor versioned doclink against docs.ansible.com (or some other config-overridden URL) * docs revisions for python interpreter discovery (cherry picked from commit 5b53c0012ab7212304c28fdd24cb33fd8ff755c2) * verify output on some distros, cleanup 2019-02-28 08:52:02 +01:00			`Configuring the right Python interpreter on target hosts`
Prefer https:// links in the docs site All the changed urls are availible by way of https://. Most of them already redirect. 2018-07-21 15:48:47 +02:00			`Mailing List <https://groups.google.com/group/ansible-project>`_
Add IRC and google groups links to each page 2012-03-31 15:55:37 +02:00			`Questions? Help? Ideas? Stop by the list on Google Groups`
			`irc.freenode.net <http://irc.freenode.net>`_
			`#ansible IRC chat channel`