Spec-Zone.ru › Ansible 2.6

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

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

Описание

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

Параметры

Параметр Варианты/Значения по умолчанию Настройка Комментарии
control_path
Записи в ini:

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

переменная среды:ANSIBLE_SSH_CONTROL_PATH
Указывает место сохранения сокетов 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
Устанавливает каталог для использования в качестве пути ssh control, если значение control path равно null.
Также предоставляет переменную `%(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
Пароль для аутентификации для remote_user. Может быть передан в качестве опции командной строки.
pipelining
boolean
По умолчанию:
"ANSIBLE_PIPELINING"
Записи в ini:

[defaults ]
pipelining = ANSIBLE_PIPELINING

переменная среды:ANSIBLE_PIPELINING
переменная: ansible_pipelining
переменная: ansible_ssh_pipelining
Pipelining уменьшает количество операций SSH, необходимых для выполнения модуля на удалённом сервере, выполняя множество модулей Ansible без фактической передачи файлов.
Это может привести к значительному улучшению производительности при включении.
Однако это конфликтует с повышением привилегий (become). Например, при использовании операций sudo необходимо сначала отключить «requiretty» в файле sudoers для целевых хостов, поэтому эта функция отключена по умолчанию.
port
int
По умолчанию:
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
Количество попыток подключения.
scp_executable
(added in 2.6)
По умолчанию:
"scp"
Записи в ini:

[ssh_connection ]
scp_executable = scp

переменная среды:ANSIBLE_SCP_EXECUTABLE
Определяет расположение бинарной программы scp. По умолчанию `scp`, которая будет использовать первый доступный бинарник в $PATH.
scp_extra_args
переменная: ansible_scp_extra_args
Дополнительные параметры, специфичные для командной строки ``scp``
scp_if_ssh По умолчанию:
"smart"
Записи в ini:

[ssh_connection ]
scp_if_ssh = smart

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

[ssh_connection ]
sftp_batch_mode = yes

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

[ssh_connection ]
sftp_executable = sftp

переменная среды:ANSIBLE_SFTP_EXECUTABLE
Это определяет расположение двоичного файла sftp. По умолчанию используется ``sftp``, который будет использовать первый доступный двоичный файл в $PATH.
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
Аргументы для передачи всем инструментам командной строки ssh
ssh_common_args
переменная: ansible_ssh_common_args
Общие дополнительные аргументы для всех инструментов командной строки ssh
ssh_executable
(добавлено в 2.2)
По умолчанию:
"ssh"
Записи ini:

[ssh_connection ]
ssh_executable = ssh

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

(добавлено в 2.5)
    Варианты:
  • no
  • yes ←
Записи ini:

[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.6/plugins/connection/ssh.html

Spec-Zone.ru

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