Skip to content

Commit

Permalink
Merge pull request #1332 from ansible/patchback/backports/stable-2.15…
Browse files Browse the repository at this point in the history
…/499f41550814fa9b9d3af7cf072c9cae35db270c/pr-1258

[PR #1258/499f4155 backport][stable-2.15] MUNI_TECH_WRITERS: Paramiko contradictions, issue #1042
  • Loading branch information
oraNod authored Apr 25, 2024
2 parents 8eb14ff + 6055f2e commit 42685c8
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 10 deletions.
4 changes: 1 addition & 3 deletions docs/docsite/rst/dev_guide/developing_plugins.rst
Original file line number Diff line number Diff line change
Expand Up @@ -310,9 +310,7 @@ There are also some tasks which are generated internally and implicitly at vario
Connection plugins
------------------

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. The most commonly used connection plugins are the ``paramiko`` SSH, native ssh (just called ``ssh``), and ``local`` connection types. All of these can be used in playbooks and with ``/usr/bin/ansible`` to connect to remote machines.

Ansible version 2.1 introduced the ``smart`` connection plugin. The ``smart`` connection type allows Ansible to automatically select either the ``paramiko`` or ``openssh`` connection plugin based on system capabilities, or the ``ssh`` connection plugin if OpenSSH supports ControlPersist.
Connection plugins allow Ansible to connect to 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. The most commonly used connection plugins are native ``ssh``, ``paramiko``, and ``local``. All of these can be used with ad-hoc tasks and in playbooks.

To create a new connection plugin (for example, to support SNMP, Message bus, or other transports), copy the format of one of the existing connection plugins and drop it into ``connection`` directory on your :ref:`local plugin path <local_plugins>`.

Expand Down
2 changes: 1 addition & 1 deletion docs/docsite/rst/inventory_guide/intro_inventory.rst
Original file line number Diff line number Diff line change
Expand Up @@ -582,7 +582,7 @@ Host connection:
.. include:: shared_snippets/SSH_password_prompt.txt

ansible_connection
Connection type to the host. This can be the name of any Ansible connection plugin. SSH protocol types are ``smart``, ``ssh`` or ``paramiko``. The default is smart. Non-SSH based types are described in the next section.
Connection type to the host. This can be the name of any Ansible connection plugin. SSH protocol types are ``ssh`` or ``paramiko``. The default is ``ssh``.

General for all connections:

Expand Down
9 changes: 3 additions & 6 deletions docs/docsite/rst/reference_appendices/glossary.rst
Original file line number Diff line number Diff line change
Expand Up @@ -354,12 +354,9 @@ when a term comes up on the mailing list.
Ansible orchestration is all about modeling that kind of process.

paramiko
By default, Ansible manages machines over SSH. The library that
Ansible uses by default to do this is a Python-powered library called
paramiko. The paramiko library is generally fast and easy to manage,
though users who want to use Kerberos or Jump Hosts may wish to switch
to a native SSH binary such as OpenSSH by specifying the connection
type in their :term:`playbooks`, or using the ``-c ssh`` flag.
Ansible can use a Python SSH implementation called ``paramiko``.
The paramiko library is generally fast and easy to manage.
To use paramiko you need to specify the connection type in your :term:`playbooks`, or by using the ``-c paramiko`` flag.

Playbooks
Playbooks are the language by which Ansible orchestrates, configures,
Expand Down

0 comments on commit 42685c8

Please sign in to comment.