ansible.builtin.ssh – подключение через двоичный файл клиента ssh

Примечание

Этот модуль входит в состав ansible-base и включён во все установки Ansible. В большинстве случаев, вы можете использовать короткое имя модуля ssh, даже не указывая ключевое слово collections:. Несмотря на это, мы рекомендуем использовать полное имя модуля (FQCN) для лёгкой ссылки на документацию модуля и для предотвращения конфликтов с другими коллекциями, которые могут иметь то же имя модуля.

Описание
Параметры

Описание

Этот плагин подключения позволяет Ansible взаимодействовать с целевыми машинами через обычную команду ssh.
Ansible не предоставляет канал для взаимодействия между пользователем и процессом ssh, чтобы вручную принять пароль для расшифровки ssh-ключа при использовании этого плагина подключения (который является стандартным). Настоятельно рекомендуется использовать ssh-agent.

Параметры

Параметр	Варианты/Значения по умолчанию	Конфигурация	Комментарии
control_path строка		записи ini: [ssh_connection] control_path = None переменная среды:ANSIBLE_SSH_CONTROL_PATH переменная: ansible_control_path добавлено в версии 2.7 ansible.builtin	Это местоположение для сохранения сокетов ControlPath ssh, оно использует подстановку переменных ssh. С версии 2.3, если значение null, ansible сгенерирует уникальный хэш. Используйте `%(directory)s` для указания места использования настройки пути к контрольному каталогу.
control_path_dir строка	По умолчанию: "~/.ansible/cp"	записи ini: [ssh_connection] control_path_dir = ~/.ansible/cp переменная среды:ANSIBLE_SSH_CONTROL_PATH_DIR переменная: ansible_control_path_dir добавлено в версии 2.7 ansible.builtin	Это задаёт каталог для использования пути управления ssh, если значение control path null. Также предоставляет переменную `%(directory)s` для настройки пути управления.
host строка	По умолчанию: "inventory_hostname"	переменная: ansible_host переменная: ansible_ssh_host	Имя хоста/IP адрес для подключения.
host_key_checking логический тип	Варианты: no yes	записи ini: [defaults] host_key_checking = None [ssh_connection] host_key_checking = None добавлено в версии 2.5 ansible.builtin переменная среды:ANSIBLE_HOST_KEY_CHECKING переменная среды:ANSIBLE_SSH_HOST_KEY_CHECKING добавлено в версии 2.5 ansible.builtin переменная: ansible_host_key_checking добавлено в версии 2.5 ansible.builtin переменная: ansible_ssh_host_key_checking добавлено в версии 2.5 ansible.builtin	Определяет, должен ли ssh проверять ключи хостов
password строка		переменная: ansible_password переменная: ansible_ssh_pass переменная: ansible_ssh_password	Пароль аутентификации для `remote_user`. Может быть передан в качестве параметра командной строки.
pipelining логический тип	Варианты: no yes По умолчанию: "ANSIBLE_PIPELINING"	записи ini: [defaults] pipelining = ANSIBLE_PIPELINING [ssh_connection] pipelining = ANSIBLE_PIPELINING переменная среды:ANSIBLE_PIPELINING переменная среды:ANSIBLE_SSH_PIPELINING переменная: ansible_pipelining переменная: ansible_ssh_pipelining	Пайплайнирование уменьшает количество операций SSH, необходимых для выполнения модуля на удалённом сервере, выполняя много модулей Ansible без фактической передачи файлов. Это может привести к значительному улучшению производительности при включении. Однако это конфликтует с повышением привилегий (become). Например, при использовании операций sudo необходимо сначала отключить "requiretty" в файле sudoers для целевых хостов, поэтому эта функция по умолчанию отключена.
port целое число	По умолчанию: 22	записи ini: [defaults] remote_port = 22 переменная среды:ANSIBLE_REMOTE_PORT переменная: ansible_port переменная: ansible_ssh_port	Удаленный порт для подключения.
private_key_file строка		записи ini: [defaults] private_key_file = None переменная среды:ANSIBLE_PRIVATE_KEY_FILE переменная: ansible_private_key_file переменная: ansible_ssh_private_key_file	Путь к файлу с закрытым ключом для аутентификации
remote_user строка		записи ini: [defaults] remote_user = None переменная среды:ANSIBLE_REMOTE_USER переменная: ansible_user переменная: ansible_ssh_user	Имя пользователя для входа на удалённый сервер, обычно задаётся ключевым словом remote_user. Если пользователь не указан, Ansible позволит двоичному файлу ssh клиента выбрать пользователя, как обычно
retries целое число	По умолчанию: 3	записи ini: [connection] retries = 3 [ssh_connection] retries = 3 переменная среды:ANSIBLE_SSH_RETRIES переменная: ansible_ssh_retries добавлено в версии 2.7 ansible.builtin	Количество попыток подключения.
scp_executable строка добавлено в версии 2.6 ansible.builtin	По умолчанию: "scp"	записи ini: [ssh_connection] scp_executable = scp переменная среды:ANSIBLE_SCP_EXECUTABLE переменная: ansible_scp_executable добавлено в версии 2.7 ansible.builtin	Это определяет расположение двоичного файла scp. По умолчанию `scp`, который будет использовать первый доступный двоичный файл в $PATH.
scp_extra_args строка		записи ini: [ssh_connection] scp_extra_args = None добавлено в версии 2.7 ansible.builtin переменная среды:ANSIBLE_SCP_EXTRA_ARGS добавлено в версии 2.7 ansible.builtin переменная: ansible_scp_extra_args	Дополнительные параметры, уникальные для CLI ``scp``
scp_if_ssh строка	По умолчанию: "smart"	записи ini: [ssh_connection] scp_if_ssh = smart переменная среды:ANSIBLE_SCP_IF_SSH переменная: ansible_scp_if_ssh добавлено в версии 2.7 ansible.builtin	Предпочтительный метод для передачи файлов через ssh При значении smart, Ansible будет пытаться до тех пор, пока один не удастся или все не потерпят неудачу Если установлено в True, будет принудительно использоваться 'scp', если False — 'sftp'
sftp_batch_mode логический тип	Варианты: no yes ←	записи ini: [ssh_connection] sftp_batch_mode = yes переменная среды:ANSIBLE_SFTP_BATCH_MODE переменная: ansible_sftp_batch_mode добавлено в версии 2.7 ansible.builtin	TODO: написать
sftp_executable строка добавлено в версии 2.6 ansible.builtin	По умолчанию: "sftp"	записи ini: [ssh_connection] sftp_executable = sftp переменная среды:ANSIBLE_SFTP_EXECUTABLE переменная: ansible_sftp_executable добавлено в версии 2.7 ansible.builtin	Это определяет расположение двоичного файла sftp. По умолчанию ``sftp``, который будет использовать первый доступный двоичный файл в $PATH.
sftp_extra_args строка		записи ini: [ssh_connection] sftp_extra_args = None добавлено в версии 2.7 ansible.builtin переменная среды:ANSIBLE_SFTP_EXTRA_ARGS добавлено в версии 2.7 ansible.builtin переменная: ansible_sftp_extra_args	Дополнительные параметры, уникальные для CLI ``sftp``
ssh_args строка	По умолчанию: "-C -o ControlMaster=auto -o ControlPersist=60s"	записи ini: [ssh_connection] ssh_args = -C -o ControlMaster=auto -o ControlPersist=60s переменная среды:ANSIBLE_SSH_ARGS переменная: ansible_ssh_args добавлено в версии 2.7 ansible.builtin	Аргументы для передачи всем ssh инструментам командной строки
ssh_common_args строка		записи ini: [ssh_connection] ssh_common_args = None добавлено в версии 2.7 ansible.builtin переменная среды:ANSIBLE_SSH_COMMON_ARGS добавлено в версии 2.7 ansible.builtin переменная: ansible_ssh_common_args	Общие дополнительные аргументы для всех инструментов ssh командной строки
ssh_executable строка добавлено в версии 2.2 ansible.builtin	По умолчанию: "ssh"	записи ini: [ssh_connection] ssh_executable = ssh переменная среды:ANSIBLE_SSH_EXECUTABLE переменная: ansible_ssh_executable добавлено в версии 2.7 ansible.builtin	Это определяет местоположение двоичного файла ssh. По умолчанию ``ssh``, который будет использовать первый доступный двоичный файл ssh в $PATH. Этот параметр обычно не требуется, он может быть полезен при ограниченном доступе к системному ssh или при использовании обёртки ssh для подключения к удалённым хостам.
ssh_extra_args строка		записи ini: [ssh_connection] ssh_extra_args = None добавлено в версии 2.7 ansible.builtin переменная среды:ANSIBLE_SSH_EXTRA_ARGS добавлено в версии 2.7 ansible.builtin переменная: ansible_ssh_extra_args	Дополнительные параметры, уникальные для CLI 'ssh'
sshpass_prompt строка добавлено в версии 2.10 ansible.builtin	По умолчанию: ""	записи ini: [ssh_connection] sshpass_prompt = переменная среды:ANSIBLE_SSHPASS_PROMPT переменная: ansible_sshpass_prompt	Запрос пароля, который должен искать sshpass. Поддерживается sshpass 1.06 и новее.
use_tty логический тип добавлено в версии 2.5 ansible.builtin	Варианты: no yes ←	записи ini: [ssh_connection] usetty = yes переменная среды:ANSIBLE_SSH_USETTY переменная: ansible_ssh_use_tty добавлено в версии 2.7 ansible.builtin	Добавить -tt к командам ssh для принудительного выделения tty

Авторы

ansible (@core)

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/ansible/builtin/ssh_connection.html