Fix connection plugin to work with Ansible 2.6.0

The connection plugin needs to follow the upstream connection/ssh
plugin's docstring, otherwise this causes failures for undefined options
sftp_executable and scp_executable. This PR adds those docstrings to
mirror upstream.

This follows on from a patch in upstream ansible:
https://github.com/ansible/ansible/pull/36648/files

Change-Id: Ia2a2f2238bb60710c7efe76e2cd9f86493833a2d
This commit is contained in:
Andy McCrae 2018-07-04 11:40:04 +01:00
parent c8e8e8d2a1
commit 8cd15c2095
1 changed files with 16 additions and 0 deletions

View File

@ -226,6 +226,22 @@ DOCUMENTATION = '''
- {key: usetty, section: ssh_connection}
type: boolean
yaml: {key: connection.usetty}
sftp_executable:
default: sftp
description:
- This defines the location of the sftp binary. It defaults to `sftp` which will use the first binary available in $PATH.
env: [{name: ANSIBLE_SFTP_EXECUTABLE}]
ini:
- {key: sftp_executable, section: ssh_connection}
version_added: "2.6"
scp_executable:
default: scp
description:
- This defines the location of the scp binary. It defaults to `scp` which will use the first binary available in $PATH.
env: [{name: ANSIBLE_SCP_EXECUTABLE}]
ini:
- {key: scp_executable, section: ssh_connection}
version_added: "2.6"
'''
import imp