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

.. _working_with_modules:

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

.. toctree::
   :maxdepth: 1

   modules_intro
   modules_support
   ../reference_appendices/common_return_values


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 7 years ago			`.. _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 7 years ago			`Working With Modules`
			`====================`
Docs updates 13 years ago
Split content into subpages. 11 years ago			`.. 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 10 years ago			`:maxdepth: 1`
Split content into subpages. 11 years ago
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 10 years ago			`modules_intro`
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. 8 years ago			`modules_support`
Collections docs generation backport (#70515) * Build documentation for Ansible-2.10 (formerly known as ACD). Builds plugin docs from collections whose source is on galaxy The new command downloads collections from galaxy, then finds the plugins inside of them to get the documentation for those plugins. * Update the python syntax checks * docs builds can now require python 3.6+. * Move plugin formatter code out to an external tool, antsibull-docs. Collection owners want to be able to extract docs for their own websites as well. * The jinja2 filters, tests, and other support code have moved to antsibull * Remove document_plugins as that has now been integrated into antsibull-docs * Cleanup and bugfix to other build script code: * The Commands class needed to have its metaclass set for abstractmethod to work correctly * Fix lint issues in some command plugins * Add the docs/docsite/rst/collections to .gitignore as everything in that directory will be generated so we don't want any of it saved in the git repository * gitignore the build dir and remove edit docs link on module pages * Add docs/rst/collections as a directory to remove on make clean * Split the collections docs from the main docs * remove version and edit on github * remove version banner for just collections * clarify examples need collection keyword defined * Remove references to plugin documentation locations that no longer exist. * Perhaps the pages in plugins/.rst should be deprecated altogether and their content moved? If not, perhaps we want to rephrase and link into the collection documentation? * Or perhaps we want to link to the plugins which are present in collections/ansible/builtin? * Remove PYTHONPATH from the build-ansible calls One of the design goals of the build-ansible.py script was for it to automatically set its library path to include the checkout of ansible and the library of code to implement itself. Because it automatically includes the checkout of ansible, we don't need to set PYTHONPATH in the Makefile any longer. * Create a command to only build ansible-base plugin docs * When building docs for devel, only build the ansible-base docs for now. This is because antsibull needs support for building a "devel tree" of docs. This can be changed once that is implemented * When building docs for the sanity tests, only build the ansible-base plugin docs for now. Those are the docs which are in this repo so that seems appropriate for now. * Docs: User guide overhaul, part 5 (#70307) (cherry picked from commit db354c03002440bbcb286b4897307dbb981d02db) * Need to return any error code from running antsibull-docs (#70763) This way we fail early if there's a problem (cherry picked from commit 1e3989c9f7919cbcfe82733711e13b93c026c2d8) Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com> 4 years ago			`../reference_appendices/common_return_values`
More exciting anchor tags, document more loop features! 11 years ago
Add auto-gen TOCs to a bunch of pages. 12 years ago
Fixing the MySQL docs 13 years ago			`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 6 years ago			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. 11 years ago
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 10 years ago			`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 13 years ago
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. 13 years ago
			`.. seealso::`

removes last :doc: links in user guide (#58433) * removes last :doc: links in user guide 6 years ago			:ref:`intro_adhoc`
doc fixes 13 years ago			`Examples of using modules in /usr/bin/ansible`
removes last :doc: links in user guide (#58433) * removes last :doc: links in user guide 6 years ago			:ref:`playbooks_intro`
			`Introduction to using modules with /usr/bin/ansible-playbook`
			:ref:`developing_modules_general`
link module dev guide from modules page 13 years ago			`How to write your own modules`
removes last :doc: links in user guide (#58433) * removes last :doc: links in user guide 6 years ago			: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. 13 years ago			`Examples of using modules with the Python API`
removes last :doc: links in user guide (#58433) * removes last :doc: links in user guide 6 years ago			: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 6 years ago			`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. 6 years ago			`Mailing List <https://groups.google.com/group/ansible-project>`_
Add IRC and google groups links to each page 13 years ago			`Questions? Help? Ideas? Stop by the list on Google Groups`
			`irc.freenode.net <http://irc.freenode.net>`_
			`#ansible IRC chat channel`