mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
ssh_executable docs (#17868)
* ssh_executable docs Added docs about ssh_executable in intro_configuration and intro_inventory under behavioral inventory params * Added full stops + \n in intro_configuration
This commit is contained in:
parent
41d6f5c635
commit
60d0e681dd
2 changed files with 17 additions and 0 deletions
|
@ -968,6 +968,19 @@ recommended if you can enable it, eliminating the need for :doc:`playbooks_accel
|
|||
|
||||
pipelining=False
|
||||
|
||||
.. _ssh_executable:
|
||||
|
||||
ssh_executable
|
||||
==============
|
||||
|
||||
.. versionadded:: 2.2
|
||||
|
||||
This is the location of the ssh binary. It defaults to ``ssh`` which will use the first ssh binary available in ``$PATH``. This config can also be overridden with ``ansible_ssh_executable`` inventory variable::
|
||||
|
||||
ssh_executable="/usr/local/bin/ssh"
|
||||
|
||||
This option is usually not required, it might be useful when access to system ssh is restricted, or when using ssh wrappers to connect to remote hosts.
|
||||
|
||||
.. _accelerate_settings:
|
||||
|
||||
Accelerated Mode Settings
|
||||
|
|
|
@ -233,6 +233,10 @@ ansible_ssh_extra_args
|
|||
This setting is always appended to the default :command:`ssh` command line.
|
||||
ansible_ssh_pipelining
|
||||
Determines whether or not to use SSH pipelining. This can override the ``pipelining`` setting in :file:`ansible.cfg`.
|
||||
.. versionadded:: 2.2
|
||||
ansible_ssh_executable
|
||||
This setting overrides the default behavior to use the system :command:`ssh`. This can override the ``ssh_executable`` setting in :file:`ansible.cfg`.
|
||||
|
||||
|
||||
Privilege escalation (see :doc:`Ansible Privilege Escalation<become>` for further details):
|
||||
|
||||
|
|
Loading…
Reference in a new issue