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