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

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет 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`.
forward_agent boolean добавлено в community.general 4.0.0	Задает параметр `ForwardAgent`. Варианты: `false` `true`
group string	Группа, к которой принадлежит этот конфигурационный файл. Если не указано, используется `user`.
host string / required	Конечная точка, для которой действительна эта конфигурация. Может быть фактическим адресом в интернете или псевдонимом, который будет подключаться к значению `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` для того, чтобы быть действительным.
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	Поддержка: полная	Может работать в режиме `check_mode` и возвращать прогноз о внесённых изменениях без модификации целевого объекта.
diff_mode	Поддержка: отсутствует	Возвращает подробную информацию о внесённых изменениях (или, возможно, о необходимых изменениях в `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

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

Значения возврата

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

Ключ	Описание
hosts_added список / элементы=строка	Список добавленных хостов. Возвращается: успешно Пример: `["example.com"]`
hosts_change_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 список / элементы=строка	Список изменённых хостов. Возвращается: успешно Пример: `["example.com"]`
hosts_removed список / элементы=строка	Список удалённых хостов. Возвращается: успешно Пример: `["example.com"]`

Авторы

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

Ссылки на сборку

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