diff options
| -rw-r--r-- | lib/ansible/plugins/connection/ssh.py | 13 |
1 files changed, 7 insertions, 6 deletions
diff --git a/lib/ansible/plugins/connection/ssh.py b/lib/ansible/plugins/connection/ssh.py index 24e5fb3d07..4cc1e0317d 100644 --- a/lib/ansible/plugins/connection/ssh.py +++ b/lib/ansible/plugins/connection/ssh.py @@ -305,12 +305,13 @@ DOCUMENTATION = ''' - name: ansible_sftp_batch_mode version_added: '2.7' ssh_transfer_method: - description: - - Preferred method to use when transferring files over SSH. - - Setting to 'smart' (default) will try them in order until one succeeds or they all fail. - - For OpenSSH >=9.0 you must add an additional option to enable scp (scp_extra_args="-O"). - - Using 'piped' creates an SSH pipe with C(dd) on either side to copy the data. - choices: ['sftp', 'scp', 'piped', 'smart'] + description: Preferred method to use when transferring files over ssh + choices: + sftp: This is the most reliable way to copy things with SSH. + scp: Deprecated in OpenSSH. For OpenSSH >=9.0 you must add an additional option to enable scp C(scp_extra_args="-O"). + piped: Creates an SSH pipe with C(dd) on either side to copy the data. + smart: Tries each method in order (sftp > scp > piped), until one succeeds or they all fail. + default: smart type: string env: [{name: ANSIBLE_SSH_TRANSFER_METHOD}] ini: |