From 3ad9b4cba62707777c3a144677e12ccd913c79a8 Mon Sep 17 00:00:00 2001 From: Abhijit Menon-Sen Date: Fri, 2 Oct 2015 11:57:47 +0530 Subject: Rework additional ssh argument handling Now we have the following ways to set additional arguments: 1. [ssh_connection]ssh_args in ansible.cfg: global setting, prepended to every command line for ssh/scp/sftp. Overrides default ControlPersist settings. 2. ansible_ssh_common_args inventory variable. Appended to every command line for ssh/scp/sftp. Used in addition to ssh_args, if set above, or the default settings. 3. ansible_{sftp,scp,ssh}_extra_args inventory variables. Appended to every command line for the relevant binary only. Used in addition to #1 and #2, if set above, or the default settings. 3. Using the --ssh-common-args or --{sftp,scp,ssh}-extra-args command line options (which are overriden by #2 and #3 above). This preserves backwards compatibility (for ssh_args in ansible.cfg), but also permits global settings (e.g. ProxyCommand via _common_args) or ssh-specific options (e.g. -R via ssh_extra_args). Fixes #12576 --- docs/man/man1/ansible-playbook.1.asciidoc.in | 19 ++++++++++++++++--- docs/man/man1/ansible-pull.1.asciidoc.in | 19 ++++++++++++++++--- docs/man/man1/ansible.1.asciidoc.in | 19 ++++++++++++++++--- 3 files changed, 48 insertions(+), 9 deletions(-) (limited to 'docs') diff --git a/docs/man/man1/ansible-playbook.1.asciidoc.in b/docs/man/man1/ansible-playbook.1.asciidoc.in index 2a1a94c5cd..356ad545e6 100644 --- a/docs/man/man1/ansible-playbook.1.asciidoc.in +++ b/docs/man/man1/ansible-playbook.1.asciidoc.in @@ -151,10 +151,23 @@ run operations with su as this user (default=root) Run operations with sudo (nopasswd) (deprecated, use become) -*--ssh-extra-args=*''-o ProxyCommand="ssh -W %h:%p ..." ...'':: +*--ssh-common-args=*''-o ProxyCommand="ssh -W %h:%p ..." ...'':: -Add the specified arguments to any ssh command-line. Useful to set a -ProxyCommand to use a jump host, but any arguments may be specified. +Add the specified arguments to any sftp/scp/ssh command-line. Useful to +set a ProxyCommand to use a jump host, but any arguments that are +accepted by all three programs may be specified. + +*--sftp-extra-args=*''-f ...'':: + +Add the specified arguments to any sftp command-line. + +*--scp-extra-args=*''-l ...'':: + +Add the specified arguments to any scp command-line. + +*--ssh-extra-args=*''-R ...'':: + +Add the specified arguments to any ssh command-line. *-U*, 'SUDO_USER', *--sudo-user=*'SUDO_USER':: diff --git a/docs/man/man1/ansible-pull.1.asciidoc.in b/docs/man/man1/ansible-pull.1.asciidoc.in index 520a60bf21..c0a5ab9ed2 100644 --- a/docs/man/man1/ansible-pull.1.asciidoc.in +++ b/docs/man/man1/ansible-pull.1.asciidoc.in @@ -105,10 +105,23 @@ Purge the checkout after the playbook is run. Sleep for random interval (between 0 and SLEEP number of seconds) before starting. This is a useful way ot disperse git requests. -*--ssh-extra-args=*''-o ProxyCommand="ssh -W %h:%p ..." ...'':: +*--ssh-common-args=*''-o ProxyCommand="ssh -W %h:%p ..." ...'':: -Add the specified arguments to any ssh command-line. Useful to set a -ProxyCommand to use a jump host, but any arguments may be specified. +Add the specified arguments to any sftp/scp/ssh command-line. Useful to +set a ProxyCommand to use a jump host, but any arguments that are +accepted by all three programs may be specified. + +*--sftp-extra-args=*''-f ...'':: + +Add the specified arguments to any sftp command-line. + +*--scp-extra-args=*''-l ...'':: + +Add the specified arguments to any scp command-line. + +*--ssh-extra-args=*''-R ...'':: + +Add the specified arguments to any ssh command-line. *-t* 'TAGS', *--tags=*'TAGS':: diff --git a/docs/man/man1/ansible.1.asciidoc.in b/docs/man/man1/ansible.1.asciidoc.in index 7578e8f8be..07172ffd9b 100644 --- a/docs/man/man1/ansible.1.asciidoc.in +++ b/docs/man/man1/ansible.1.asciidoc.in @@ -143,10 +143,23 @@ Run operations with su as this user (default=root) Run the command as the user given by -u and sudo to root. -*--ssh-extra-args=*''-o ProxyCommand="ssh -W %h:%p ..." ...'':: +*--ssh-common-args=*''-o ProxyCommand="ssh -W %h:%p ..." ...'':: -Add the specified arguments to any ssh command-line. Useful to set a -ProxyCommand to use a jump host, but any arguments may be specified. +Add the specified arguments to any sftp/scp/ssh command-line. Useful to +set a ProxyCommand to use a jump host, but any arguments that are +accepted by all three programs may be specified. + +*--sftp-extra-args=*''-f ...'':: + +Add the specified arguments to any sftp command-line. + +*--scp-extra-args=*''-l ...'':: + +Add the specified arguments to any scp command-line. + +*--ssh-extra-args=*''-R ...'':: + +Add the specified arguments to any ssh command-line. *-U* 'SUDO_USERNAME', *--sudo-user=*'SUDO_USERNAME':: -- cgit v1.2.3