github_key - Управление ключами доступа к GitHub.
Новая версия 2.2.
Обзор
- Создает, удаляет или обновляет ключи доступа к GitHub.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| force |
| Значение по умолчанию yes, которое заменит существующий удаленный ключ, если он отличается от pubkey. Если no, ключ будет установлен только если ключ с заданным name не существует. |
| name обязательно | Имя SSH-ключа | |
| pubkey | Значение по умолчанию: нет | Значение открытого SSH-ключа. Требуется, когда state=present. |
| state |
| Удалить ключ, убедиться, что он существует, или обновить его значение. |
| token обязательно | Токен доступа к GitHub с разрешением на просмотр и создание открытых ключей. |
Примеры
- name: Read SSH public key to authorize
shell: cat /home/foo/.ssh/id_rsa.pub
register: ssh_pub_key
- name: Authorize key with GitHub
local_action:
module: github_key
name: Access Key for Some Machine
token: '{{ github_access_token }}'
pubkey: '{{ ssh_pub_key.stdout }}'
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| deleted_keys список | При state=absent | Массив объектов ключей, которые были удалены. Присутствует только при state=absent Пример: [{'url': 'http://example.com/github key', 'read_only': False, 'created_at': 'ГГГГ-ММ-ДДЧЧ:ММ:СС', 'id': 0, 'key': 'Ключ в кодировке BASE64'}] |
| key словарь | успех | Метаданные о только что созданном ключе. Присутствует только при state=present Пример: {'url': 'http://example.com/github key', 'read_only': False, 'created_at': 'ГГГГ-ММ-ДДЧЧ:ММ:СС', 'id': 0, 'key': 'Ключ в кодировке BASE64'} |
| matching_keys список | При state=present | Массив ключей, соответствующих заданному имени. Присутствует только при state=present Пример: [{'url': 'http://example.com/github key', 'read_only': False, 'created_at': 'ГГГГ-ММ-ДДЧЧ:ММ:СС', 'id': 0, 'key': 'Ключ в кодировке BASE64'}] |
Статус
Этот модуль помечен как preview, что означает, что он не гарантирует обратную совместимость.
Автор
- Robert Estelle (@erydo)
Подсказка
Если вы заметили какие-либо проблемы в этом руководстве, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.5/modules/github_key_module.html
