1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00
community.general/plugins/modules/cloud/vultr/vultr_ssh_key.py
Ansible Core Team aebc1b03fd Initial commit
2020-03-09 09:11:07 +00:00

239 lines
6.3 KiB
Python

#!/usr/bin/python
# -*- coding: utf-8 -*-
#
# (c) 2017, René Moser <mail@renemoser.net>
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
from __future__ import (absolute_import, division, print_function)
__metaclass__ = type
ANSIBLE_METADATA = {'metadata_version': '1.1',
'status': ['preview'],
'supported_by': 'community'}
DOCUMENTATION = '''
---
module: vultr_ssh_key
short_description: Manages ssh keys on Vultr.
description:
- Create, update and remove ssh keys.
author: "René Moser (@resmo)"
options:
name:
description:
- Name of the ssh key.
required: true
type: str
ssh_key:
description:
- SSH public key.
- Required if C(state=present).
type: str
state:
description:
- State of the ssh key.
default: present
choices: [ present, absent ]
type: str
extends_documentation_fragment:
- community.general.vultr
'''
EXAMPLES = '''
- name: ensure an SSH key is present
vultr_ssh_key:
name: my ssh key
ssh_key: "{{ lookup('file', '~/.ssh/id_rsa.pub') }}"
- name: ensure an SSH key is absent
vultr_ssh_key:
name: my ssh key
state: absent
'''
RETURN = '''
---
vultr_api:
description: Response from Vultr API with a few additions/modification
returned: success
type: complex
contains:
api_account:
description: Account used in the ini file to select the key
returned: success
type: str
sample: default
api_timeout:
description: Timeout used for the API requests
returned: success
type: int
sample: 60
api_retries:
description: Amount of max retries for the API requests
returned: success
type: int
sample: 5
api_retry_max_delay:
description: Exponential backoff delay in seconds between retries up to this max delay value.
returned: success
type: int
sample: 12
version_added: '2.9'
api_endpoint:
description: Endpoint used for the API requests
returned: success
type: str
sample: "https://api.vultr.com"
vultr_ssh_key:
description: Response from Vultr API
returned: success
type: complex
contains:
id:
description: ID of the ssh key
returned: success
type: str
sample: 5904bc6ed9234
name:
description: Name of the ssh key
returned: success
type: str
sample: my ssh key
date_created:
description: Date the ssh key was created
returned: success
type: str
sample: "2017-08-26 12:47:48"
ssh_key:
description: SSH public key
returned: success
type: str
sample: "ssh-rsa AA... someother@example.com"
'''
from ansible.module_utils.basic import AnsibleModule
from ansible_collections.community.general.plugins.module_utils.vultr import (
Vultr,
vultr_argument_spec,
)
class AnsibleVultrSshKey(Vultr):
def __init__(self, module):
super(AnsibleVultrSshKey, self).__init__(module, "vultr_ssh_key")
self.returns = {
'SSHKEYID': dict(key='id'),
'name': dict(),
'ssh_key': dict(),
'date_created': dict(),
}
def get_ssh_key(self):
ssh_keys = self.api_query(path="/v1/sshkey/list")
if ssh_keys:
for ssh_key_id, ssh_key_data in ssh_keys.items():
if ssh_key_data.get('name') == self.module.params.get('name'):
return ssh_key_data
return {}
def present_ssh_key(self):
ssh_key = self.get_ssh_key()
if not ssh_key:
ssh_key = self._create_ssh_key(ssh_key)
else:
ssh_key = self._update_ssh_key(ssh_key)
return ssh_key
def _create_ssh_key(self, ssh_key):
self.result['changed'] = True
data = {
'name': self.module.params.get('name'),
'ssh_key': self.module.params.get('ssh_key'),
}
self.result['diff']['before'] = {}
self.result['diff']['after'] = data
if not self.module.check_mode:
self.api_query(
path="/v1/sshkey/create",
method="POST",
data=data
)
ssh_key = self.get_ssh_key()
return ssh_key
def _update_ssh_key(self, ssh_key):
param_ssh_key = self.module.params.get('ssh_key')
if param_ssh_key != ssh_key['ssh_key']:
self.result['changed'] = True
data = {
'SSHKEYID': ssh_key['SSHKEYID'],
'ssh_key': param_ssh_key,
}
self.result['diff']['before'] = ssh_key
self.result['diff']['after'] = data
self.result['diff']['after'].update({'date_created': ssh_key['date_created']})
if not self.module.check_mode:
self.api_query(
path="/v1/sshkey/update",
method="POST",
data=data
)
ssh_key = self.get_ssh_key()
return ssh_key
def absent_ssh_key(self):
ssh_key = self.get_ssh_key()
if ssh_key:
self.result['changed'] = True
data = {
'SSHKEYID': ssh_key['SSHKEYID'],
}
self.result['diff']['before'] = ssh_key
self.result['diff']['after'] = {}
if not self.module.check_mode:
self.api_query(
path="/v1/sshkey/destroy",
method="POST",
data=data
)
return ssh_key
def main():
argument_spec = vultr_argument_spec()
argument_spec.update(dict(
name=dict(type='str', required=True),
ssh_key=dict(type='str',),
state=dict(type='str', choices=['present', 'absent'], default='present'),
))
module = AnsibleModule(
argument_spec=argument_spec,
required_if=[
('state', 'present', ['ssh_key']),
],
supports_check_mode=True,
)
vultr_ssh_key = AnsibleVultrSshKey(module)
if module.params.get('state') == "absent":
ssh_key = vultr_ssh_key.absent_ssh_key()
else:
ssh_key = vultr_ssh_key.present_ssh_key()
result = vultr_ssh_key.get_result(ssh_key)
module.exit_json(**result)
if __name__ == '__main__':
main()