diff options
| author | Andrea Tartaglia <me@andreatartaglia.com> | 2016-10-05 23:18:40 +0100 |
|---|---|---|
| committer | Adrian Likins <alikins@redhat.com> | 2016-10-05 18:18:39 -0400 |
| commit | 60d0e681dd03993fb64a20237ad01f5bbfb92f3e (patch) | |
| tree | 6b04464288d86d046f2b67348839ecb5d0c0d9a1 | |
| parent | 41d6f5c635724b3d385dcb94782ab370ea6dd565 (diff) | |
| download | ansible-60d0e681dd03993fb64a20237ad01f5bbfb92f3e.tar.gz | |
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
| -rw-r--r-- | docsite/rst/intro_configuration.rst | 13 | ||||
| -rw-r--r-- | docsite/rst/intro_inventory.rst | 4 |
2 files changed, 17 insertions, 0 deletions
diff --git a/docsite/rst/intro_configuration.rst b/docsite/rst/intro_configuration.rst index 68a92abed5..4bdd172881 100644 --- a/docsite/rst/intro_configuration.rst +++ b/docsite/rst/intro_configuration.rst @@ -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 diff --git a/docsite/rst/intro_inventory.rst b/docsite/rst/intro_inventory.rst index dbec705598..af36191a0c 100644 --- a/docsite/rst/intro_inventory.rst +++ b/docsite/rst/intro_inventory.rst @@ -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): |