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.
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, если значение control path равно null. Также предоставляет переменную `%(directory)s` для настройки control path.
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: [connection] pipelining = ANSIBLE_PIPELINING [ssh_connection] pipelining = ANSIBLE_PIPELINING переменная среды:ANSIBLE_PIPELINING переменная среды:ANSIBLE_SSH_PIPELINING переменная: ansible_pipelining переменная: ansible_ssh_pipelining	Pipelining уменьшает количество операций подключения, необходимых для выполнения модуля на удалённом сервере, путём выполнения многих модулей 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	Дополнительные параметры, специфичные для командной строки ``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	Дополнительные параметры, специфичные для командной строки ``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 cli
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 CLI
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	Дополнительные параметры, специфичные для командной строки '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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/ansible/builtin/ssh_connection.html