Spec-Zone.ru › Ansible 2.5

ssh - подключение через двоичный файл ssh клиента

  • Описание
  • Параметры
  • Статус
    • Автор

Описание

  • Этот плагин подключения позволяет Ansible взаимодействовать с целевыми машинами через обычную командную строку ssh.

Параметры

Параметр Варианты/Значения по умолчанию Конфигурация Комментарии
control_path Значение по умолчанию:
None
Элементы конфигурационного файла:

[ssh_connection ]
control_path = None

Переменная среды:ANSIBLE_SSH_CONTROL_PATH
Это местоположение для сохранения сокетов ControlPath ssh, оно использует подстановку переменных ssh.
Начиная с версии 2.3, если значение null, Ansible сгенерирует уникальный хеш. Используйте `%(directory)s` для указания места использования настройки пути к каталогу control.
control_path_dir Значение по умолчанию:
~/.ansible/cp
Элементы конфигурационного файла:

[ssh_connection ]
control_path_dir = ~/.ansible/cp

Переменная среды:ANSIBLE_SSH_CONTROL_PATH_DIR
Это устанавливает каталог для использования пути ssh control, если значение control path равно null.
Также предоставляет переменную `%(directory)s` для настройки пути control.
host Значение по умолчанию:
inventory_hostname
Переменная: ansible_host
Переменная: ansible_ssh_host
Имя хоста/IP-адрес для подключения.
host_key_checking
Элементы конфигурационного файла:

[defaults ]
host_key_checking = VALUE

[ssh_connection ]
host_key_checking = VALUE

Переменная среды: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
Пароль для аутентификации для remote_user. Может быть предоставлен как опция командной строки.
pipelining Значение по умолчанию:
ANSIBLE_PIPELINING
Элементы конфигурационного файла:

[defaults ]
pipelining = ANSIBLE_PIPELINING

Переменная среды:ANSIBLE_PIPELINING
Переменная: ansible_pipelining
Переменная: ansible_ssh_pipelining
Пайплайнирование сокращает количество операций SSH, необходимых для выполнения модуля на удаленном сервере, выполняя множество модулей Ansible без фактического переноса файлов.
Это может привести к значительному повышению производительности при включении.
Однако это конфликтует с повышением привилегий (become). Например, при использовании операций sudo необходимо сначала отключить «requiretty» в файле sudoers для целевых хостов, поэтому эта функция отключена по умолчанию.
port Значение по умолчанию:
22
Элементы конфигурационного файла:

[defaults ]
remote_port = 22

Переменная среды:ANSIBLE_REMOTE_PORT
Переменная: ansible_port
Переменная: ansible_ssh_port
Удаленный порт для подключения.
private_key_file
Элементы конфигурационного файла:

[defaults ]
private_key_file = VALUE

Переменная среды:ANSIBLE_PRIVATE_KEY_FILE
Переменная: ansible_private_key_file
Переменная: ansible_ssh_private_key_file
Путь к файлу закрытого ключа для использования в целях аутентификации
remote_user
Элементы конфигурационного файла:

[defaults ]
remote_user = VALUE

Переменная среды:ANSIBLE_REMOTE_USER
Переменная: ansible_user
Переменная: ansible_ssh_user
Имя пользователя для входа на удаленный сервер, обычно задается ключевым словом remote_user.
Если пользователь не указан, Ansible позволит двоичному файлу клиента ssh выбрать пользователя, как обычно
retries Значение по умолчанию:
3
Элементы конфигурационного файла:

[connection ]
retries = 3

[ssh_connection ]
retries = 3

Переменная среды:ANSIBLE_SSH_RETRIES
Количество попыток подключения.
scp_extra_args
Переменная: ansible_scp_extra_args
Дополнительные параметры, специфичные для 'scp' CLI
scp_if_ssh Значение по умолчанию:
smart
Элементы конфигурационного файла:

[ssh_connection ]
scp_if_ssh = smart

Переменная среды:ANSIBLE_SCP_IF_SSH
Предпочитаемый метод для передачи файлов по ssh
При установке в значение smart, Ansible будет пытаться их использовать, пока один не пройдет или все не потерпят неудачу
Если установлено в значение True, то будет принудительно использован 'scp', если False, то будет использован 'sftp'
sftp_batch_mode Значение по умолчанию:
yes
Элементы конфигурационного файла:

[ssh_connection ]
sftp_batch_mode = yes

Переменная среды:ANSIBLE_SFTP_BATCH_MODE
TODO: написать
sftp_extra_args
Переменная: ansible_sftp_extra_args
Дополнительные параметры, специфичные для 'sftp' CLI
ssh_args Значение по умолчанию:
-C -o ControlMaster=auto -o ControlPersist=60s
Элементы конфигурационного файла:

[ssh_connection ]
ssh_args = -C -o ControlMaster=auto -o ControlPersist=60s

Переменная среды:ANSIBLE_SSH_ARGS
Аргументы для передачи всем инструментам ssh cli
ssh_common_args
Переменная: ansible_ssh_common_args
Общие дополнительные аргументы для всех инструментов ssh CLI
ssh_executable
(добавлен в 2.2)
Значение по умолчанию:
ssh
Элементы конфигурационного файла:

[ssh_connection ]
ssh_executable = ssh

Переменная среды:ANSIBLE_SSH_EXECUTABLE
Это определяет расположение двоичного файла ssh. По умолчанию это `ssh`, что будет использовать первый двоичный файл ssh, доступный в $PATH.
Эта опция обычно не требуется, она может быть полезна, когда доступ к системе ssh ограничен или при использовании оболочек ssh для подключения к удаленным хостам.
ssh_extra_args
Переменная: ansible_ssh_extra_args
Дополнительные параметры, специфичные для 'ssh' CLI
use_tty
(добавлен в 2.5)
Значение по умолчанию:
yes
Элементы конфигурационного файла:

[ssh_connection ]
usetty = yes

Переменная среды:ANSIBLE_SSH_USETTY
добавить -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.5/plugins/connection/ssh.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API