ansibleInventory


Parameters

ParameterExplanation
ansible_connectionConnection type to the host. This can be the name of any of ansible’s connection plugins. SSH protocol types are smart, ssh or paramiko. The default is smart. Non-SSH based types are described in the next section.
ansible_hostThe name of the host to connect to, if different from the alias you wish to give to it.
ansible_portThe ssh port number, if not 22
ansible_userThe default ssh user name to use.
ansible_ssh_passThe ssh password to use (this is insecure, we strongly recommend using --ask-pass or SSH keys)
ansible_ssh_private_key_filePrivate key file used by ssh. Useful if using multiple keys and you don’t want to use SSH agent.
ansible_ssh_common_argsThis setting is always appended to the default command line for sftp, scp, and ssh. Useful to configure a ProxyCommand for a certain host (or group).
ansible_sftp_extra_argsThis setting is always appended to the default sftp command line.
ansible_scp_extra_argsThis setting is always appended to the default scp command line.
ansible_ssh_extra_argsThis setting is always appended to the default ssh command line.
ansible_ssh_pipeliningDetermines whether or not to use SSH pipelining. This can override the pipelining setting in ansible.cfg.
ansible_becomeEquivalent to ansible_sudo or ansible_su, allows to force privilege escalation
ansible_become_methodAllows to set privilege escalation method
ansible_become_userEquivalent to ansible_sudo_user or ansible_su_user, allows to set the user you become through privilege escalation
ansible_become_passEquivalent to ansible_sudo_pass or ansible_su_pass, allows you to set the privilege escalation password
ansible_shell_typeThe shell type of the target system. You should not use this setting unless you have set the ansible_shell_executable to a non-Bourne (sh) compatible shell. 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.
ansible_python_interpreterThe target host python path. This is useful for systems with more than one Python or not located at /usr/bin/python such as *BSD, or where /usr/bin/python is not a 2.X series Python. We do not use the /usr/bin/env mechanism as that requires the remote user’s path to be set right and also assumes the python executable is named python, where the executable might be named something like python2.6.
ansible_*_interpreterWorks for anything such as ruby or perl and works just like ansible_python_interpreter. This replaces shebang of modules which will run on that host.
ansible_shell_executableThis 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. /bin/sh is not installed on the target machine or cannot be run from sudo.). New in version 2.1.