Cleanups to docs and rename of inv var

This commit is contained in:
Toshio Kuratomi 2016-03-18 06:40:04 -07:00
parent 8fc1c26c37
commit e25caebe7a
3 changed files with 6 additions and 6 deletions

View file

@ -289,7 +289,7 @@ This indicates the command to use to spawn a shell under a sudo environment. Us
executable = /bin/bash executable = /bin/bash
Starting in version 2.1 this can be overriden by the inventory var ``ansible_executable``. Starting in version 2.1 this can be overriden by the inventory var ``ansible_shell_executable``.
.. _filter_plugins: .. _filter_plugins:

View file

@ -247,7 +247,7 @@ Privilege escalation (see :doc:`Ansible Privilege Escalation<become>` for furthe
Remote host environment parameters:: Remote host environment parameters::
ansible_shell_type ansible_shell_type
The shell type of the target system. You should not use this setting unless you have set the 'executable' to a non sh compatible shell. The shell type of the target system. You should not use this setting unless you have set the 'ansible_shell_executable' to a non sh compatible shell.
By default commands are formatted using 'sh'-style syntax. By default commands are formatted using 'sh'-style syntax.
Setting this to 'csh' or 'fish' will cause commands executed on target systems to follow those shell's syntax instead. Setting this to 'csh' or 'fish' will cause commands executed on target systems to follow those shell's syntax instead.
ansible_python_interpreter ansible_python_interpreter
@ -264,9 +264,9 @@ Remote host environment parameters::
:: ::
ansible_executable ansible_shell_executable
This sets the shell the ansible controller will use on the target machine, overrides ``executable`` in ``ansible.cfg`` which defaults to '/bin/sh'. This sets the shell the ansible controller will use on the target machine, overrides ``executable`` in ``ansible.cfg`` which defaults to ``/bin/sh``.
You should really only change it if is not possible to use '/bin/sh' (i.e. it is not in the list of allowed shells for your users). You should really only change it if is not possible to use ``/bin/sh`` (i.e. ``/bin/sh`` is not installed on the target machine.).
Examples from a host file:: Examples from a host file::

View file

@ -78,7 +78,7 @@ MAGIC_VARIABLE_MAPPING = dict(
su_pass = ('ansible_su_password', 'ansible_su_pass'), su_pass = ('ansible_su_password', 'ansible_su_pass'),
su_exe = ('ansible_su_exe',), su_exe = ('ansible_su_exe',),
su_flags = ('ansible_su_flags',), su_flags = ('ansible_su_flags',),
executable = ('ansible_executable',), executable = ('ansible_shell_executable',),
) )
SU_PROMPT_LOCALIZATIONS = [ SU_PROMPT_LOCALIZATIONS = [