46b1a999c6
* 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 db354c0300)
* 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 1e3989c9f7)
Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>
78 lines
3.5 KiB
ReStructuredText
78 lines
3.5 KiB
ReStructuredText
.. _connection_plugins:
|
|
|
|
Connection Plugins
|
|
==================
|
|
|
|
.. contents::
|
|
:local:
|
|
:depth: 2
|
|
|
|
Connection plugins allow Ansible to connect to the target hosts so it can execute tasks on them. Ansible ships with many connection plugins, but only one can be used per host at a time.
|
|
|
|
By default, Ansible ships with several plugins. The most commonly used are the :ref:`paramiko SSH<paramiko_ssh_connection>`, native ssh (just called :ref:`ssh<ssh_connection>`), and :ref:`local<local_connection>` connection types. All of these can be used in playbooks and with :command:`/usr/bin/ansible` to decide how you want to talk to remote machines.
|
|
|
|
The basics of these connection types are covered in the :ref:`getting started<intro_getting_started>` section.
|
|
|
|
.. _ssh_plugins:
|
|
|
|
``ssh`` plugins
|
|
---------------
|
|
|
|
Because ssh is the default protocol used in system administration and the protocol most used in Ansible, ssh options are included in the command line tools. See :ref:`ansible-playbook` for more details.
|
|
|
|
.. _enabling_connection:
|
|
|
|
Adding connection plugins
|
|
-------------------------
|
|
|
|
You can extend Ansible to support other transports (such as SNMP or message bus) by dropping a custom plugin
|
|
into the ``connection_plugins`` directory.
|
|
|
|
.. _using_connection:
|
|
|
|
Using connection plugins
|
|
------------------------
|
|
|
|
You can set the connection plugin globally via :ref:`configuration<ansible_configuration_settings>`, at the command line (``-c``, ``--connection``), as a :ref:`keyword <playbook_keywords>` in your play, or by setting a :ref:`variable<behavioral_parameters>`, most often in your inventory.
|
|
For example, for Windows machines you might want to set the :ref:`winrm <winrm_connection>` plugin as an inventory variable.
|
|
|
|
Most connection plugins can operate with minimal configuration. By default they use the :ref:`inventory hostname<inventory_hostnames_lookup>` and defaults to find the target host.
|
|
|
|
Plugins are self-documenting. Each plugin should document its configuration options. The following are connection variables common to most connection plugins:
|
|
|
|
:ref:`ansible_host<magic_variables_and_hostvars>`
|
|
The name of the host to connect to, if different from the :ref:`inventory <intro_inventory>` hostname.
|
|
:ref:`ansible_port<faq_setting_users_and_ports>`
|
|
The ssh port number, for :ref:`ssh <ssh_connection>` and :ref:`paramiko_ssh <paramiko_ssh_connection>` it defaults to 22.
|
|
:ref:`ansible_user<faq_setting_users_and_ports>`
|
|
The default user name to use for log in. Most plugins default to the 'current user running Ansible'.
|
|
|
|
Each plugin might also have a specific version of a variable that overrides the general version. For example, ``ansible_ssh_host`` for the :ref:`ssh <ssh_connection>` plugin.
|
|
|
|
.. _connection_plugin_list:
|
|
|
|
Plugin List
|
|
-----------
|
|
|
|
You can use ``ansible-doc -t connection -l`` to see the list of available plugins.
|
|
Use ``ansible-doc -t connection <plugin name>`` to see detailed documentation and examples.
|
|
|
|
|
|
.. seealso::
|
|
|
|
:ref:`Working with Playbooks<working_with_playbooks>`
|
|
An introduction to playbooks
|
|
:ref:`callback_plugins`
|
|
Ansible callback plugins
|
|
:ref:`Filters<playbooks_filters>`
|
|
Jinja2 filter plugins
|
|
:ref:`Tests<playbooks_tests>`
|
|
Jinja2 test plugins
|
|
:ref:`Lookups<playbooks_lookups>`
|
|
Jinja2 lookup plugins
|
|
:ref:`vars_plugins`
|
|
Ansible vars plugins
|
|
`User Mailing List <https://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
|