community.general.ssh_config – Управление конфигурацией SSH для пользователя
Примечание
Этот плагин входит в сборку community.general (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install community.general.
Для использования в книге задач укажите: community.general.ssh_config.
Добавлено в версии 2.0.0: сборки community.general
Описание
- Настраивает хосты SSH со специальными ``IdentityFile`` и именами хостов.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- StormSSH
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| group строка | Группа, к которой принадлежит этот конфигурационный файл. Если не указано, используется user. | |
| host строка / обязательно | Конечная точка, для которой данная конфигурация действительна. Может быть фактическим адресом в интернете или псевдонимом, который будет подключен к значению hostname. | |
| hostname строка | Фактический хост для подключения при подключении к заданному хосту. | |
| identity_file путь | Путь к файлу идентификации (приватный ключ SSH), который будет использоваться при подключении к данному хосту. Файл должен существовать и иметь режим 0600, чтобы быть действительным. | |
| port строка | Фактический порт для подключения при подключении к заданному хосту. | |
| proxycommand строка | Устанавливает параметр ProxyCommand. | |
| remote_user строка | Указывает пользователя, под которым нужно войти. | |
| ssh_config_file путь | Файл конфигурации SSH. Если user и этот параметр не указаны, используется /etc/ssh/ssh_config.Взаимоисключающий с user. | |
| state строка |
| Должен ли существовать запись хоста или нет. |
| strict_host_key_checking строка |
| Требовать строгое проверку ключа хоста при подключении к удаленному хосту. |
| user строка | Пользовательская учетная запись, к которой принадлежит этот конфигурационный файл. Если не указано и ssh_config_file не указан, используется /etc/ssh/ssh_config.Если указан пользователь, используется ~/.ssh/config.Взаимоисключающий с ssh_config_file. | |
| user_known_hosts_file строка | Устанавливает параметр файла известных хостов пользователя. |
Примечания
Примечание
- Поддерживает режим проверки.
Примеры
- 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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/general/ssh_config_module.html
