From 6dd93fa964ce655620ebc5308c5788bcb188d195 Mon Sep 17 00:00:00 2001 From: Michael DeHaan Date: Sun, 30 Jun 2013 18:32:49 -0400 Subject: [PATCH] Some minor doc tweaks --- docsite/latest/rst/patterns.rst | 41 +++++++++++++++++---------------- 1 file changed, 21 insertions(+), 20 deletions(-) diff --git a/docsite/latest/rst/patterns.rst b/docsite/latest/rst/patterns.rst index 5b659abc42..03a9549154 100644 --- a/docsite/latest/rst/patterns.rst +++ b/docsite/latest/rst/patterns.rst @@ -68,39 +68,40 @@ In 1.1 and later, you can also select the connection type and user on a per host All of these variables can of course also be set outside of the inventory file, in 'host_vars' if you wish to keep your inventory file simple. -Parameters -++++++++++ +List of Reserved Inventory Parameters ++++++++++++++++++++++++++++++ -You can set these parameters on each host. +As a summary, you can set these parameters as host inventory variables. (Some we have already +mentioned). ansible_ssh_host - Actual hostname + The name of the host to connect to, if different from the alias you wish to give to it. ansible_ssh_port - ssh port number + The ssh port number, if not 22 ansible_ssh_user - ssh user name + The default ssh user name to use. ansible_ssh_pass - ssh password + The ssh password to use (this is insecure, we strongly recommend using --ask-pass or SSH keys) ansible_connection - Connection type of the host. Candidates are local, ssh or paramiko. - Default is paramiko + Connection type of the host. Candidates are local, ssh or paramiko. Default is paramiko ansible_ssh_private_key_file - Private key file used by ssh + Private key file used by ssh. Useful if using multiple keys and you don't want to use SSH agent. ansible_syslog_facility - Define syslog facility + The syslog facility to log to. ansible_python_interpreter - Define a target host python path. This is userful for systems with more - than one Python or not located at "/usr/bin/python" such as \*BSD. + The target host python path. This is userful 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. ansible\_\*\_interpreter - \* is anything such as ruby or perl. This replaces shebang of - modules which will run on that host. + Works 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. -Examples:: +Examples from a host file:: - backdoor_host ansible_ssh_port=2222 ansible_ssh_user=manager - aws_host ansible_ssh_private_key_file=/home/example/.ssh/aws.pem - freebsd_host ansible_python_interpreter=/usr/local/bin/python - ruby_module_host ansible_ruby_interpreter=/usr/bin/ruby.1.9.3 + some_host ansible_ssh_port=2222 ansible_ssh_user=manager + aws_host ansible_ssh_private_key_file=/home/example/.ssh/aws.pem + freebsd_host ansible_python_interpreter=/usr/local/bin/python + ruby_module_host ansible_ruby_interpreter=/usr/bin/ruby.1.9.3 Selecting Targets