Модуль community.general.ssh_config — управление конфигурацией SSH для пользователя

Примечание

Этот модуль входит в коллекцию community.general (версия 12.6.1).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.general. Для использования этого модуля могут потребоваться дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: community.general.ssh_config.

Добавлено в community.general 2.0.0

Краткое описание
Требования
Параметры
Атрибуты
Примеры
Возвращаемые значения

Краткое описание

Настраивает хосты SSH с помощью специальных IdentityFile и имён хостов.

Требования

Следующие компоненты необходимы на хосте, выполняющем этот модуль.

paramiko

Параметры

Параметр	Комментарии
add_keys_to_agent boolean добавлено в community.general 8.2.0	Задаёт параметр `AddKeysToAgent`. Варианты: `false` `true`
controlmaster string добавлено в community.general 8.1.0	Задаёт параметр `ControlMaster`. Варианты: `"yes"` `"no"` `"ask"` `"auto"` `"autoask"`
controlpath string добавлено в community.general 8.1.0	Задаёт параметр `ControlPath`.
controlpersist string добавлено в community.general 8.1.0	Задаёт параметр `ControlPersist`.
dynamicforward string добавлено в community.general 10.1.0	Задаёт параметр `DynamicForward`.
forward_agent boolean добавлено в community.general 4.0.0	Задаёт параметр `ForwardAgent`. Варианты: `false` `true`
group string	Группа, которой принадлежит этот файл конфигурации. Если не указана, используется `user`.
host string / обязательный	Конечная точка, для которой действует эта конфигурация. Это может быть реальный адрес в интернете или псевдоним, подключающийся к значению `hostname`.
host_key_algorithms string добавлено в community.general 6.1.0	Задаёт параметр `HostKeyAlgorithms`.
hostname string	Фактический хост, к которому выполняется подключение при подключении к указанному хосту.
identities_only boolean добавлено в community.general 8.2.0	Указывает, что SSH должен использовать только настроенные файлы идентификации и сертификатов для аутентификации (файлы по умолчанию либо файлы, явно заданные в файлах `ssh_config` или переданные в командной строке ssh), даже если `ssh-agent`, `PKCS11Provider` или `SecurityKeyProvider` предлагает больше идентификаторов. Варианты: `false` `true`
identity_file path	Путь к файлу идентификации (закрытому ключу SSH), используемому при подключении к этому хосту. Чтобы файл считался допустимым, он должен существовать и иметь режим `0600`.
other_options dictionary добавлено в community.general 10.4.0	Позволяет задавать произвольные параметры записей конфигурации SSH с помощью словаря. Имена ключей должны быть в нижнем регистре. Ключи со значениями в верхнем регистре отклоняются. Значения должны быть строками. Значения других типов отклоняются.
port string	Фактический порт для подключения к указанному хосту.
proxycommand string	Задаёт параметр `ProxyCommand`. Несовместим с `proxyjump`.
proxyjump string добавлено в community.general 6.5.0	Задаёт параметр `ProxyJump`. Несовместим с `proxycommand`.
remote_user string	Указывает пользователя для входа в систему.
ssh_config_file path	Файл конфигурации SSH. Если `user` и этот параметр не указаны, используется `/etc/ssh/ssh_config`. Несовместим с `user`.
state string	Определяет, должна ли существовать запись хоста. Варианты: `"present"` ← (по умолчанию) `"absent"`
strict_host_key_checking string	Определяет, следует ли строго проверять ключ хоста при подключении к удалённому хосту. Значение `accept-new` поддерживается начиная с community.general 8.6.0. Варианты: `"yes"` `"no"` `"ask"` `"accept-new"`
user string	Учётная запись пользователя, которому принадлежит этот файл конфигурации. Если пользователь не указан и `ssh_config_file` не задан, используется `/etc/ssh/ssh_config`. Если пользователь указан, используется `~/.ssh/config`. Несовместим с `ssh_config_file`.
user_known_hosts_file string	Задаёт параметр файла известных хостов пользователя.

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: full	Может работать в режиме `check_mode` и возвращать прогноз изменения состояния, не изменяя целевой объект.
diff_mode	Поддержка: none	В режиме diff возвращает сведения об изменениях (или о том, что может потребовать изменения в `check_mode`).

Примеры

- name: Add a host in the configuration
  community.general.ssh_config:
    user: akasurde
    host: "example.com"
    hostname: "github.com"
    identity_file: "/home/akasurde/.ssh/id_rsa"
    port: '2223'
    state: present
    other_options:
      serveraliveinterval: '30'

- name: Add SSH config with key auto-added to agent
  community.general.ssh_config:
    user: devops
    host: "example.com"
    hostname: "staging.example.com"
    identity_file: "/home/devops/.ssh/id_rsa"
    add_keys_to_agent: true
    state: present

- name: Delete a host from the configuration
  community.general.ssh_config:
    ssh_config_file: "{{ ssh_config_test }}"
    host: "example.com"
    state: absent

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:

Ключ	Описание
hosts_added list / elements=string	Список добавленных хостов. Возвращается: success Пример: `["example.com"]`
hosts_change_diff list / elements=string	Список изменений хостов в формате diff. Возвращается: при изменении Пример: `[{"example.com": {"new": {"hostname": "github.com", "identityfile": ["/tmp/test_ssh_config/fake_id_rsa"], "port": "2224"}, "old": {"hostname": "github.com", "identityfile": ["/tmp/test_ssh_config/fake_id_rsa"], "port": "2224"}}}]`
hosts_changed list / elements=string	Список изменённых хостов. Возвращается: success Пример: `["example.com"]`
hosts_removed list / elements=string	Список удалённых хостов. Возвращается: success Пример: `["example.com"]`

Авторы

Björn Andersson (@gaqzi)
Abhijeet Kasurde (@Akasurde)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/general/ssh_config_module.html