cmueller/ansible
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

ssh_executable docs (#17868)

Browse source 
* 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:
Andrea Tartaglia 2016-10-05 23:18:40 +01:00 committed by Adrian Likins
parent 41d6f5c635
commit 60d0e681dd
2 changed files with 17 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
docsite/rst/intro_configuration.rst
View file

@ -968,6 +968,19 @@ recommended if you can enable it, eliminating the need for :doc:`playbooks_accel
pipelining=False 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: .. _accelerate_settings:
Accelerated Mode Settings Accelerated Mode Settings

4
docsite/rst/intro_inventory.rst
View file

@ -233,6 +233,10 @@ ansible_ssh_extra_args
This setting is always appended to the default :command:`ssh` command line. This setting is always appended to the default :command:`ssh` command line.
ansible_ssh_pipelining ansible_ssh_pipelining
Determines whether or not to use SSH pipelining. This can override the ``pipelining`` setting in :file:`ansible.cfg`. 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): Privilege escalation (see :doc:`Ansible Privilege Escalation<become>` for further details):