ssh docs fixes (#82902)

This commit is contained in:
Brian Coca 2024-03-26 17:07:32 -04:00 committed by GitHub
parent fde206499d
commit 5c804cbf6f
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 7 additions and 6 deletions

View File

@ -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: