community.general.github_key – Manage GitHub access keys.
community.general.github_key – Manage GitHub access keys.
Note
This plugin is part of the community.general collection (version 1.3.2).
To install it use: ansible-galaxy collection install community.general
.
To use it in a playbook, specify: community.general.github_key
.
Synopsis
- Creates, removes, or updates GitHub access keys.
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
force boolean |
|
The default is |
name string / required |
SSH key name | |
pubkey string |
SSH public key value. Required when | |
state string |
|
Whether to remove a key, ensure that it exists, or update its value. |
token string / required |
GitHub Access Token with permission to list and create public keys. |
Examples
- 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 }}'
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
deleted_keys list / elements=string |
When state=absent |
An array of key objects that were deleted. Only present on state=absent
Sample: [{'created_at': 'YYYY-MM-DDTHH:MM:SZ', 'id': 0, 'key': 'BASE64 encoded key', 'read_only': False, 'url': 'http://example.com/github key'}] |
key dictionary |
success |
Metadata about the key just created. Only present on state=present
Sample: {'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 |
When state=present |
An array of keys matching the specified name. Only present on state=present
Sample: [{'created_at': 'YYYY-MM-DDTHH:MM:SZ', 'id': 0, 'key': 'BASE64 encoded key', 'read_only': False, 'url': 'http://example.com/github key'}] |
Authors
- 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.10/collections/community/general/github_key_module.html