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

Примечание

Этот модуль входит в коллекцию community.general (версия 12.6.1).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install community.general.

Чтобы использовать её в плейбуке, укажите: community.general.github_key.

Краткое описание
Параметры
Атрибуты
Примеры
Возвращаемые значения

Краткое описание

Создаёт, удаляет или обновляет ключи доступа GitHub.
Работает как с GitHub.com, так и с установками GitHub Enterprise Server.

Параметры

Параметр	Комментарии
api_url string добавлено в community.general 11.0.0	URL API GitHub, если вы используете не github.com, а собственный экземпляр GitHub Enterprise. По умолчанию: `"https://api.github.com"`
force boolean	По умолчанию используется `true`: существующий удалённый ключ заменяется, если он отличается от `pubkey`. Если задано `false`, ключ устанавливается, только если ключа с указанным `name` не существует. Варианты: `false` `true` ← (по умолчанию)
name string / обязательный	Имя ключа SSH.
pubkey string	Значение открытого ключа SSH. Обязателен, если `state=present`.
state string	Удалить ключ, обеспечить его наличие или обновить его значение. Варианты: `"present"` ← (по умолчанию) `"absent"`
token string / обязательный	Токен доступа GitHub с разрешением перечислять и создавать открытые ключи.

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная	Может выполняться в режиме `check_mode` и возвращать прогноз статуса изменений, не изменяя целевой объект.
diff_mode	Поддержка: нет	В режиме diff возвращает сведения об изменениях (или о возможных изменениях в `check_mode`).

Примеры

- 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 }}'

# Alternatively, a single task can be used reading a key from a file on the controller
- name: Authorize key with GitHub
  community.general.github_key:
    name: Access Key for Some Machine
    token: '{{ github_access_token }}'
    pubkey: "{{ lookup('ansible.builtin.file', '/home/foo/.ssh/id_rsa.pub') }}"

# GitHub Enterprise Server usage
- name: Authorize key with GitHub Enterprise
  community.general.github_key:
    name: Access Key for Some Machine
    token: '{{ github_enterprise_token }}'
    pubkey: "{{ lookup('ansible.builtin.file', '/home/foo/.ssh/id_rsa.pub') }}"
    api_url: 'https://github.company.com/api/v3'

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:

Ключ	Описание
deleted_keys list / elements=string	Массив удалённых объектов ключей. Присутствует только при state=absent. Возвращается: при state=absent Пример: `[{"created_at": "YYYY-MM-DDTHH:MM:SZ", "id": 0, "key": "BASE64 encoded key", "read_only": false, "url": "http://example.com/github key"}]`
key dictionary	Метаданные о только что созданном ключе. Присутствует только при state=present. Возвращается: при успешном выполнении Пример: `{"created_at": "YYYY-MM-DDTHH:MM:SZ", "id": 0, "key": "BASE64 encoded key", "read_only": false, "url": "http://example.com/github key"}`
matching_keys list / elements=string	Массив ключей, соответствующих указанному имени. Присутствует только при state=present. Возвращается: при state=present Пример: `[{"created_at": "YYYY-MM-DDTHH:MM:SZ", "id": 0, "key": "BASE64 encoded key", "read_only": false, "url": "http://example.com/github key"}]`

Авторы

Robert Estelle (@erydo)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/general/github_key_module.html