Spec-Zone.ru › Ansible 2.4

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

Новая версия 2.2.

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

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

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

Параметры

параметр обязательно по умолчанию возможные значения примечания
force
нет да
  • да
  • нет
По умолчанию yes, что заменит существующий удалённый ключ, если он отличается от pubkey. Если no, ключ будет установлен только если ключ с указанным name не существует.
name
да
Имя SSH-ключа
pubkey
нет нет
Значение публичного SSH-ключа. Требуется, когда state=present.
state
нет present
  • present
  • absent
Удаление ключа, обеспечение его существования или обновление его значения.
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 ключ', 'read_only': False, 'created_at': 'ГГГГ-ММ-ДДЧЧ:ММ:СС', 'id': 0, 'key': 'ключ в кодировке BASE64'}]
key
Метаданные о только что созданном ключе. Присутствует только при state=present
успех словарь {'url': 'http://example.com/github ключ', 'read_only': False, 'created_at': 'ГГГГ-ММ-ДДЧЧ:ММ:СС', 'id': 0, 'key': 'ключ в кодировке BASE64'}
matching_keys
Массив ключей, соответствующих указанному имени. Присутствует только при state=present
При state=present список [{'url': 'http://example.com/github ключ', 'read_only': False, 'created_at': 'ГГГГ-ММ-ДДЧЧ:ММ:СС', 'id': 0, 'key': 'ключ в кодировке BASE64'}]

Статус

Этот модуль помечен как бета, что означает, что его интерфейс не гарантируется обратной совместимости.

Для получения помощи в разработке модулей, если у вас есть желание, пожалуйста, прочитайте Информация о сообществе и участие, Тестирование Ansible и Разработка модулей.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/github_key_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API