community.general.github_key — Управление ключами доступа к GitHub.

Примечание

Этот плагин входит в коллекцию community.general (версия 2.0.1).

Для его установки используйте: ansible-galaxy collection install community.general.

Для использования в плейбуке укажите: community.general.github_key.

Обзор
Параметры
Примеры
Значения возврата

Обзор

Создает, удаляет или обновляет ключи доступа к GitHub.

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
force boolean	Варианты: no yes ←	По умолчанию `yes`, что приведет к замене существующего удаленного ключа, если он отличается от `pubkey`. Если `no`, ключ будет установлен только в том случае, если ключ с заданным `name` не существует.
name string / обязательно		Имя SSH-ключа
pubkey string		Значение открытого SSH-ключа. Требуется, когда `state=present`.
state string	Варианты: present ← absent	Удалить ключ, убедиться, что он существует, или обновить его значение.
token string / обязательно		Токен доступа к GitHub с разрешением на список и создание открытых ключей.

Примеры

- name: Read SSH public key to authorize
  ansible.builtin.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 Пример: [{'created_at': 'ГГГГ-ММ-ДДЧЧ:ММ:СС', 'id': 0, 'key': 'Ключ в кодировке BASE64', 'read_only': False, 'url': 'http://example.com/github key'}]
key словарь	Успешно	Метаданные о только что созданном ключе. Присутствует только при state=present Пример: {'created_at': 'ГГГГ-ММ-ДДЧЧ:ММ:СС', 'id': 0, 'key': 'Ключ в кодировке BASE64', 'read_only': False, 'url': 'http://example.com/github key'}
matching_keys список / элементы=строка	При state=present	Массив ключей, соответствующих заданному имени. Присутствует только при state=present Пример: [{'created_at': 'ГГГГ-ММ-ДДЧЧ:ММ:СС', 'id': 0, 'key': 'Ключ в кодировке BASE64', 'read_only': False, 'url': 'http://example.com/github key'}]

Авторы

Robert Estelle (@erydo)

© 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/github_key_module.html