Contradictions in documentation about paramiko being the default

[dilyanpalauzov]

https://docs.ansible.com/ansible/latest/reference_appendices/glossary.html#term-paramiko contains:

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 playbooks, or using the -c ssh flag.

This means, that unless explicitly changed, Paramiko is used by default. But https://docs.ansible.com/ansible/latest/inventory_guide/connection_details.html#controlpersist-and-paramiko states the opposite: prefer openssh over paramiko and there is no explicit configuration necessary to get openssh over paramiko.

Also https://docs.ansible.com/ansible/latest/porting_guides/porting_guide_9.html#id20 says for Ansible-core 2.9:

the ‘smart’ option for setting a connection plugin is being removed as it’s main purpose (choosing between ssh and paramiko) is now irrelevant.

But https://docs.ansible.com/ansible/latest/dev_guide/developing_plugins.html#connection-plugins still contains:

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.

without stating that smart is gone.

Finally https://docs.ansible.com/ansible/latest/inventory_guide/intro_inventory.html#connecting-to-hosts-behavioral-inventory-parameters says for 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.

So smart does not exist, but is the default for ansible_connection.

[ansible-documentation-bot]

Thanks for your Ansible docs contribution! We talk about Ansible documentation on matrix at #docs:ansible.im and on libera IRC at #ansible-docs if you ever want to join us and chat about the docs! We meet there on Tuesdays (see the Ansible calendar) and welcome additions to our weekly agenda items - scroll down to find the upcoming agenda and add a comment to put something new on that agenda.

[oraNod]

Thanks for reporting this and providing all the details @dilyanpalauzov I've added the DaWGs label so we can discuss it tomorrow. You're welcome to join us on Matrix at https://matrix.to/#/#docs:ansible.com

[oraNod]

Labelling this as a good first issue after discussion in DaWGs. If any contributors are interested in working on this, and need some guidance on how to proceed, get in touch on Matrix at https://matrix.to/#/#docs:ansible.com

[oraNod]

This blog post could be helpful in resolving this issue: https://www.ansible.com/blog/new-libssh-connection-plugin-for-ansible-network

[gotmax23]

https://docs.ansible.com/ansible/latest/reference_appendices/glossary.html#term-paramiko contains:

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 playbooks, or using the -c ssh flag.

This means, that unless explicitly changed, Paramiko is used by default. But https://docs.ansible.com/ansible/latest/inventory_guide/connection_details.html#controlpersist-and-paramiko states the opposite: prefer openssh over paramiko and there is no explicit configuration necessary to get openssh over paramiko.

Yeah, this doc is out of date. paramiko is no longer the default; the ssh connection plugin is.

[gotmax23]

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.

So smart does not exist, but is the default for ansible_connection.

It should be "SSH protocols types are ssh or paramiko" and "The default is ssh," if I'm not mistaken.

[gotmax23]

the ‘smart’ option for setting a connection plugin is being removed as it’s main purpose (choosing between ssh and paramiko) is now irrelevant.

I also submitted ansible/ansible#82594 to fix this spelling error.

[oraNod]

Estimated effort: S (MUNI tech writers)

[Devids10]

Hello! I would like to work with this issue. I am from the MUNI tech writing course

[oraNod]

Hello @Devids10 and welcome! I've assigned the issue to you now. Please feel free to ask any questions here or head over to the docs channel on Matrix.

[dilyanpalauzov]

Should in examples/scripts/uptime.py this also be updated?

    context.CLIARGS = ImmutableDict(connection='smart', …)

[oraNod]

Should in examples/scripts/uptime.py this also be updated?

    context.CLIARGS = ImmutableDict(connection='smart', …)

Thanks for catching this @dilyanpalauzov I've fixed it in a follow up PR and also removed another smart reference from the FAQ. Please feel free to comment #1340