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