github_key - Управление ключами доступа GitHub.
Новая версия 2.2.
Обзор
- Создаёт, удаляет или обновляет ключи доступа GitHub.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| force bool |
| Значение по умолчанию 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 Пример: [{'id': 0, 'key': 'Ключ в кодировке BASE64', 'url': 'http://example.com/github key', 'created_at': 'ГГГГ-ММ-ДДЧЧ:ММ:СС', 'read_only': False}] |
| key словарь | Успех | Метаданные о только что созданном ключе. Присутствует только при state=present Пример: {'id': 0, 'key': 'Ключ в кодировке BASE64', 'url': 'http://example.com/github key', 'created_at': 'ГГГГ-ММ-ДДЧЧ:ММ:СС', 'read_only': False} |
| matching_keys список | При state=present | Массив ключей, соответствующих заданному имени. Присутствует только при state=present Пример: [{'id': 0, 'key': 'Ключ в кодировке BASE64', 'url': 'http://example.com/github key', 'created_at': 'ГГГГ-ММ-ДДЧЧ:ММ:СС', 'read_only': False}] |
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется обратной совместимостью.
Техническое обслуживание
Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом Ansible. Дополнительную информацию см. в разделе Поддержка и техническое обслуживание модулей.
Список других модулей, поддерживаемых сообществом Ansible, см. здесь.
Автор
- 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.6/modules/github_key_module.html
