ensure all config sources for ssh options

This commit is contained in:
Brian Coca 2018-06-05 10:50:15 -04:00 committed by Brian Coca
parent 087efe4232
commit 1a70681630

View file

@ -55,8 +55,18 @@ DOCUMENTATION = '''
key: 'ssh_args' key: 'ssh_args'
env: env:
- name: ANSIBLE_SSH_ARGS - name: ANSIBLE_SSH_ARGS
vars:
- name: ansible_ssh_args
version_added: '2.7'
ssh_common_args: ssh_common_args:
description: Common extra args for all ssh CLI tools description: Common extra args for all ssh CLI tools
ini:
- section: 'ssh_connection'
key: 'ssh_common_args'
version_added: '2.7'
env:
- name: ANSIBLE_SSH_COMMON_ARGS
version_added: '2.7'
vars: vars:
- name: ansible_ssh_common_args - name: ansible_ssh_common_args
ssh_executable: ssh_executable:
@ -70,6 +80,9 @@ DOCUMENTATION = '''
- {key: ssh_executable, section: ssh_connection} - {key: ssh_executable, section: ssh_connection}
#const: ANSIBLE_SSH_EXECUTABLE #const: ANSIBLE_SSH_EXECUTABLE
version_added: "2.2" version_added: "2.2"
vars:
- name: ansible_ssh_executable
version_added: '2.7'
sftp_executable: sftp_executable:
default: sftp default: sftp
description: description:
@ -78,6 +91,9 @@ DOCUMENTATION = '''
ini: ini:
- {key: sftp_executable, section: ssh_connection} - {key: sftp_executable, section: ssh_connection}
version_added: "2.6" version_added: "2.6"
vars:
- name: ansible_sftp_executable
version_added: '2.7'
scp_executable: scp_executable:
default: scp default: scp
description: description:
@ -86,18 +102,42 @@ DOCUMENTATION = '''
ini: ini:
- {key: scp_executable, section: ssh_connection} - {key: scp_executable, section: ssh_connection}
version_added: "2.6" version_added: "2.6"
vars:
- name: ansible_scp_executable
version_added: '2.7'
scp_extra_args: scp_extra_args:
description: Extra exclusive to the ``scp`` CLI description: Extra exclusive to the ``scp`` CLI
vars: vars:
- name: ansible_scp_extra_args - name: ansible_scp_extra_args
env:
- name: ANSIBLE_SCP_EXTRA_ARGS
version_added: '2.7'
ini:
- key: scp_extra_args
section: ssh_connection
version_added: '2.7'
sftp_extra_args: sftp_extra_args:
description: Extra exclusive to the ``sftp`` CLI description: Extra exclusive to the ``sftp`` CLI
vars: vars:
- name: ansible_sftp_extra_args - name: ansible_sftp_extra_args
env:
- name: ANSIBLE_SFTP_EXTRA_ARGS
version_added: '2.7'
ini:
- key: sftp_extra_args
section: ssh_connection
version_added: '2.7'
ssh_extra_args: ssh_extra_args:
description: Extra exclusive to the 'ssh' CLI description: Extra exclusive to the 'ssh' CLI
vars: vars:
- name: ansible_ssh_extra_args - name: ansible_ssh_extra_args
env:
- name: ANSIBLE_SSH_EXTRA_ARGS
version_added: '2.7'
ini:
- key: ssh_extra_args
section: ssh_connection
version_added: '2.7'
retries: retries:
# constant: ANSIBLE_SSH_RETRIES # constant: ANSIBLE_SSH_RETRIES
description: Number of attempts to connect. description: Number of attempts to connect.
@ -110,6 +150,9 @@ DOCUMENTATION = '''
key: retries key: retries
- section: ssh_connection - section: ssh_connection
key: retries key: retries
vars:
- name: ansible_ssh_retries
version_added: '2.7'
port: port:
description: Remote port to connect to. description: Remote port to connect to.
type: int type: int
@ -176,6 +219,9 @@ DOCUMENTATION = '''
ini: ini:
- key: control_path - key: control_path
section: ssh_connection section: ssh_connection
vars:
- name: ansible_control_path
version_added: '2.7'
control_path_dir: control_path_dir:
default: ~/.ansible/cp default: ~/.ansible/cp
description: description:
@ -186,6 +232,9 @@ DOCUMENTATION = '''
ini: ini:
- section: ssh_connection - section: ssh_connection
key: control_path_dir key: control_path_dir
vars:
- name: ansible_control_path_dir
version_added: '2.7'
sftp_batch_mode: sftp_batch_mode:
default: 'yes' default: 'yes'
description: 'TODO: write it' description: 'TODO: write it'
@ -193,6 +242,9 @@ DOCUMENTATION = '''
ini: ini:
- {key: sftp_batch_mode, section: ssh_connection} - {key: sftp_batch_mode, section: ssh_connection}
type: bool type: bool
vars:
- name: ansible_sftp_batch_mode
version_added: '2.7'
scp_if_ssh: scp_if_ssh:
default: smart default: smart
description: description:
@ -202,6 +254,9 @@ DOCUMENTATION = '''
env: [{name: ANSIBLE_SCP_IF_SSH}] env: [{name: ANSIBLE_SCP_IF_SSH}]
ini: ini:
- {key: scp_if_ssh, section: ssh_connection} - {key: scp_if_ssh, section: ssh_connection}
vars:
- name: ansible_scp_if_ssh
version_added: '2.7'
use_tty: use_tty:
version_added: '2.5' version_added: '2.5'
default: 'yes' default: 'yes'
@ -210,7 +265,9 @@ DOCUMENTATION = '''
ini: ini:
- {key: usetty, section: ssh_connection} - {key: usetty, section: ssh_connection}
type: bool type: bool
yaml: {key: connection.usetty} vars:
- name: ansible_ssh_use_tty
version_added: '2.7'
''' '''
import errno import errno