Spec-Zone.ru › Ansible 2.9

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

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

Описание

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

Параметры

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

[ssh_connection]
control_path = ЗНАЧЕНИЕ

переменная среды:ANSIBLE_SSH_CONTROL_PATH
переменная: ansible_control_path
Это место для сохранения сокетов ControlPath ssh, оно использует подстановку переменных ssh.
Начиная с версии 2.3, если значение пустое, 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
Это задаёт каталог для использования пути ssh control, если параметр control path пустой.
Также предоставляет переменную `%(directory)s` для настройки пути control.
host
-
По умолчанию:
"inventory_hostname"
переменная: ansible_host
переменная: ansible_ssh_host
Имя хоста/IP-адрес для подключения.
host_key_checking
boolean
Элементы ini:

[defaults]
host_key_checking = ЗНАЧЕНИЕ

[ssh_connection]
host_key_checking = ЗНАЧЕНИЕ

переменная среды: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
boolean
По умолчанию:
"ANSIBLE_PIPELINING"
Элементы ini:

[defaults]
pipelining = ANSIBLE_PIPELINING

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

[defaults]
remote_port = 22

переменная среды:ANSIBLE_REMOTE_PORT
переменная: ansible_port
переменная: ansible_ssh_port
Удаленный порт для подключения.
private_key_file
-
Элементы ini:

[defaults]
private_key_file = ЗНАЧЕНИЕ

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

[defaults]
remote_user = ЗНАЧЕНИЕ

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

[connection]
retries = 3

[ssh_connection]
retries = 3

переменная среды:ANSIBLE_SSH_RETRIES
переменная: ansible_ssh_retries
Количество попыток подключения.
scp_executable
-
добавлено в 2.6
По умолчанию:
"scp"
Элементы ini:

[ssh_connection]
scp_executable = scp

переменная среды:ANSIBLE_SCP_EXECUTABLE
переменная: ansible_scp_executable
Это определяет местоположение двоичного файла scp. По умолчанию это `scp`, который будет использовать первый доступный двоичный файл в $PATH.
scp_extra_args
-
Элементы ini:

[ssh_connection]
scp_extra_args = ЗНАЧЕНИЕ

переменная среды:ANSIBLE_SCP_EXTRA_ARGS
переменная: ansible_scp_extra_args
Дополнительные параметры, специфичные для командной строки ``scp``
scp_if_ssh
-
По умолчанию:
"smart"
Элементы ini:

[ssh_connection]
scp_if_ssh = smart

переменная среды:ANSIBLE_SCP_IF_SSH
переменная: ansible_scp_if_ssh
Предпочтительный метод для передачи файлов по ssh
При значении smart Ansible будет пытаться их использовать до тех пор, пока один из них не удастся или они все не завершатся ошибкой
Если установлено в True, будет принудительно использоваться 'scp', если False - 'sftp'
sftp_batch_mode
boolean
    Варианты:
  • нет
  • да ←
Элементы ini:

[ssh_connection]
sftp_batch_mode = да

переменная среды:ANSIBLE_SFTP_BATCH_MODE
переменная: ansible_sftp_batch_mode
TODO: написать описание
sftp_executable
-
добавлено в 2.6
По умолчанию:
"sftp"
Элементы ini:

[ssh_connection]
sftp_executable = sftp

переменная среды:ANSIBLE_SFTP_EXECUTABLE
переменная: ansible_sftp_executable
Это определяет местоположение двоичного файла sftp. По умолчанию это ``sftp``, который будет использовать первый доступный двоичный файл в $PATH.
sftp_extra_args
-
Элементы ini:

[ssh_connection]
sftp_extra_args = ЗНАЧЕНИЕ

переменная среды:ANSIBLE_SFTP_EXTRA_ARGS
переменная: 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
Аргументы для передачи всем инструментам ssh cli
ssh_common_args
-
Элементы ini:

[ssh_connection]
ssh_common_args = ЗНАЧЕНИЕ

переменная среды:ANSIBLE_SSH_COMMON_ARGS
переменная: ansible_ssh_common_args
Общие дополнительные аргументы для всех инструментов ssh CLI
ssh_executable
-
По умолчанию:
"ssh"
Элементы ini:

[ssh_connection]
ssh_executable = ssh

переменная среды:ANSIBLE_SSH_EXECUTABLE
переменная: ansible_ssh_executable
Это определяет местоположение двоичного файла ssh. По умолчанию это ``ssh``, который будет использовать первый доступный двоичный файл ssh в $PATH.
Этот параметр обычно не требуется, он может быть полезен, когда доступ к системному ssh ограничен или при использовании оболочек ssh для подключения к удалённым хостам.
ssh_extra_args
-
Элементы ini:

[ssh_connection]
ssh_extra_args = ЗНАЧЕНИЕ

переменная среды:ANSIBLE_SSH_EXTRA_ARGS
переменная: ansible_ssh_extra_args
Дополнительные параметры, специфичные для командной строки 'ssh'
use_tty
boolean
добавлено в 2.5
    Варианты:
  • нет
  • да ←
Элементы ini:

[ssh_connection]
usetty = да

переменная среды:ANSIBLE_SSH_USETTY
переменная: ansible_ssh_use_tty
добавить -tt к командам ssh для принудительного выделения tty

Статус

  • Отсутствует гарантия обратной совместимости интерфейса этого подключения. [превью]
  • Это подключение поддерживается сообществом Ansible. [community]

Авторы

  • 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.9/plugins/connection/ssh.html

Spec-Zone.ru

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