authorized_key – Добавляет или удаляет SSH авторизованный ключ
Описание
- Добавляет или удаляет SSH авторизованные ключи для определённых учётных записей пользователей.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| comment строка добавлен в 2.4 | Изменяет комментарий к открытому ключу. Перезапись комментария полезна в случаях, таких как извлечение его из GitHub или GitLab. Если комментарий не указан, существующий комментарий сохранится. | |
| exclusive логическое значение |
| Определяет, следует ли удалить все другие ключи, не указанные явно, из файла authorized_keys. Несколько ключей могут быть указаны в одном значении типа key, разделяя их переводами строк.Этот параметр не учитывает циклы, поэтому если вы используете with_, он будет эксклюзивным для каждой итерации цикла.Если вам нужны несколько ключей в файле, вам необходимо передать их все в key в одной группе, как указано выше. |
| follow логическое значение добавлен в 2.7 |
| Следовать ссылке на путь вместо её замены. |
| key строка / обязательно | SSH открытый ключ(и) в виде строки или (с Ansible 1.9) URL (https://github.com/username.keys). | |
| key_options - | Строка опций ssh ключа, которая будет добавлена перед ключом в файле authorized_keys. | |
| manage_dir логическое значение |
| Управляет ли этот модуль директорией файла authorized key. Если установлено yes, модуль создаст директорию, а также установит владельца и права доступа к существующей директории.Убедитесь, что установлено manage_dir=no, если вы используете альтернативную директорию для authorized_keys, как указано в path, так как вы можете заблокировать себя от доступа SSH.См. пример ниже. |
| path путь | Альтернативный путь к файлу authorized_keys. Если не указано, значение по умолчанию ~/.ssh/authorized_keys. | |
| state строка |
| Определяет, должен ли данный ключ (с заданными key_options) быть в файле или нет. |
| user строка / обязательно | Имя пользователя на удалённом хосте, файл authorized_keys которого будет изменён. | |
| validate_certs логическое значение |
| Это применимо только при использовании https URL в качестве источника ключей. Если установлено no, сертификаты SSL не будут проверены.Это следует устанавливать только на сайтах под личным контролем, использующих самозаверяющие сертификаты, так как это позволяет избежать проверки источника сайта. До версии 2.1 код работал так, как если бы это значение было установлено на yes. |
Примеры
- name: Set authorized key taken from file
authorized_key:
user: charlie
state: present
key: "{{ lookup('file', '/home/charlie/.ssh/id_rsa.pub') }}"
- name: Set authorized keys taken from url
authorized_key:
user: charlie
state: present
key: https://github.com/charlie.keys
- name: Set authorized key in alternate location
authorized_key:
user: charlie
state: present
key: "{{ lookup('file', '/home/charlie/.ssh/id_rsa.pub') }}"
path: /etc/ssh/authorized_keys/charlie
manage_dir: False
- name: Set up multiple authorized keys
authorized_key:
user: deploy
state: present
key: '{{ item }}'
with_file:
- public_keys/doe-jane
- public_keys/doe-john
- name: Set authorized key defining key options
authorized_key:
user: charlie
state: present
key: "{{ lookup('file', '/home/charlie/.ssh/id_rsa.pub') }}"
key_options: 'no-port-forwarding,from="10.0.1.1"'
- name: Set authorized key without validating the TLS/SSL certificates
authorized_key:
user: charlie
state: present
key: https://github.com/user.keys
validate_certs: False
- name: Set authorized key, removing all the authorized keys already set
authorized_key:
user: root
key: '{{ item }}'
state: present
exclusive: True
with_file:
- public_keys/doe-jane
- name: Set authorized key for user ubuntu copying it from current user
authorized_key:
user: ubuntu
state: present
key: "{{ lookup('file', lookup('env','HOME') + '/.ssh/id_rsa.pub') }}"
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие — поля, уникальные для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| exclusive логическое значение | успех | Если ключ был принудительно установлен как эксклюзивный или нет. |
| key строка | успех | Ключ, с которым работал модуль. Пример: https://github.com/user.keys |
| key_option строка | успех | Опции ключа, связанные с ключом. |
| keyfile строка | успех | Путь к файлу authorized key. Пример: /home/user/.ssh/authorized_keys |
| manage_dir логическое значение | успех | Управлял ли этот модуль директорией файла authorized key. Пример: True |
| path строка | успех | Альтернативный путь к файлу authorized_keys. |
| state строка | успех | Наличие или отсутствие данного ключа (с заданными key_options) в файле. Пример: наличие |
| unique логическое значение | успех | Является ли ключ уникальным. |
| user строка | успех | Имя пользователя на удалённом хосте, файл authorized_keys которого был изменён. Пример: user |
| validate_certs логическое значение | успех | Это применимо только при использовании https URL в качестве источника ключей. Если установлено no, сертификаты SSL не будут проверены.Пример: True |
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается командой Ansible Core. [core]
Поддержка Red Hat
Дополнительную информацию о поддержке этого модуля Red Hat можно найти в этой статье базы знаний Red Hat.
Авторы
- Команда 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/modules/authorized_key_module.html
