From ae2e2ccbaa947ceb5cb666b1ab8e8b79027e4eb8 Mon Sep 17 00:00:00 2001 From: heet007 <66148620+heet007-code@users.noreply.github.com> Date: Sat, 5 Oct 2024 13:50:50 -0700 Subject: [PATCH] Add missing documentation for ssh_connection.sftp_batch_mode and environment variables --- lib/ansible/plugins/connection/ssh.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/lib/ansible/plugins/connection/ssh.py b/lib/ansible/plugins/connection/ssh.py index b5cda5a8518..e8de2b54243 100644 --- a/lib/ansible/plugins/connection/ssh.py +++ b/lib/ansible/plugins/connection/ssh.py @@ -296,7 +296,9 @@ DOCUMENTATION = ''' version_added: '2.7' sftp_batch_mode: default: true - description: 'TODO: write it' + description: ' + - If set to C(true), Ansible will use SFTP batch mode for transfers. This can optimize file transfers, particularly for larger files. + - Set to C(false) to disable batch mode and send files one at a time.' env: [{name: ANSIBLE_SFTP_BATCH_MODE}] ini: - {key: sftp_batch_mode, section: ssh_connection}