github_key - Manage GitHub access keys.
New in version 2.2.
Synopsis
- Creates, removes, or updates GitHub access keys.
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
force |
|
The default is
yes , which will replace the existing remote key if it's different than
pubkey . If
no , the key will only be set if no key with the given
name exists.
|
name
required
|
SSH key name
|
|
pubkey | Default:
none
|
SSH public key value. Required when
state=present .
|
state |
|
Whether to remove a key, ensure that it exists, or update its value.
|
token
required
|
GitHub Access Token with permission to list and create public keys.
|
Examples
- 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 }}'
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
deleted_keys
list
|
When state=absent |
An array of key objects that were deleted. Only present on state=absent
Sample:
[{'url': 'http://example.com/github key', 'read_only': False, 'created_at': 'YYYY-MM-DDTHH:MM:SZ', 'id': 0, 'key': 'BASE64 encoded key'}]
|
key
dict
|
success |
Metadata about the key just created. Only present on state=present
Sample:
{'url': 'http://example.com/github key', 'read_only': False, 'created_at': 'YYYY-MM-DDTHH:MM:SZ', 'id': 0, 'key': 'BASE64 encoded key'}
|
matching_keys
list
|
When state=present |
An array of keys matching the specified name. Only present on state=present
Sample:
[{'url': 'http://example.com/github key', 'read_only': False, 'created_at': 'YYYY-MM-DDTHH:MM:SZ', 'id': 0, 'key': 'BASE64 encoded key'}]
|
Status
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Author
- Robert Estelle (@erydo)
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.5/modules/github_key_module.html