summaryrefslogtreecommitdiff
path: root/lib/ansible/modules/cloud/vultr
diff options
context:
space:
mode:
authorYanis Guenane <yguenane@gmail.com>2018-07-18 09:53:58 +0200
committerRené Moser <mail@renemoser.net>2018-07-18 09:53:58 +0200
commit9b898ebc202d5cc8171b1f16d30d24d0b8f15d57 (patch)
treece69770b7ac9c920a9b7383b2ccf55109548549d /lib/ansible/modules/cloud/vultr
parent7dbdc8a92e70bc472b50d2bb64989d439b382588 (diff)
downloadansible-9b898ebc202d5cc8171b1f16d30d24d0b8f15d57.tar.gz
Vultr: Introducing vr_sshkey_facts module (#42615)
This commit introduces a new module called vr_sshkey_facts. This module aims to return the list of SSH keys avaiable in Vultr. Sample available here: ``` "vultr_sshkey_facts": [ { "date_created": "2018-07-10 14:49:13", "id": "5b43c760d7d84", "name": "me@home", "ssh_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC+ZFQv3MyjtL1BMpSA0o0gIkzLVVC711rthT29hBNeORdNowQ7FSvVWUdAbTq00U7Xzak1ANIYLJyn+0r7olsdG4XEiUR0dqgC99kbT/QhY5mLe5lpl7JUjW9ctn00hNmt+TswpatCKWPNwdeAJT2ERynZaqPobENgewrwerqewqIVew7qFeZygxsPVn36EUr2Cdq7Nb7U0XFXh3x1p0v0+MbL4tiJwPlMAGvFTKIMt+EaA+AsRIxiOo9CMk5ZuOl9pT8h5vNuEOcvS0qx4v44EAD2VOsCVCcrPNMcpuSzZP8dRTGU9wRREAWXngD0Zq9YJMH38VTxHiskoBw1NnPz me@home" } ] ```
Diffstat (limited to 'lib/ansible/modules/cloud/vultr')
-rw-r--r--lib/ansible/modules/cloud/vultr/vr_ssh_key_facts.py121
1 files changed, 121 insertions, 0 deletions
diff --git a/lib/ansible/modules/cloud/vultr/vr_ssh_key_facts.py b/lib/ansible/modules/cloud/vultr/vr_ssh_key_facts.py
new file mode 100644
index 0000000000..b733dcaf6e
--- /dev/null
+++ b/lib/ansible/modules/cloud/vultr/vr_ssh_key_facts.py
@@ -0,0 +1,121 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+#
+# (c) 2018, Yanis Guenane <yanis+ansible@guenane.org>
+# 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 = r'''
+---
+module: vr_ssh_key_facts
+short_description: Gather facts about the Vultr SSH keys available.
+description:
+ - Gather facts about SSH keys available.
+version_added: "2.7"
+author: "Yanis Guenane (@Spredzy)"
+extends_documentation_fragment: vultr
+'''
+
+EXAMPLES = r'''
+- name: Gather Vultr SSH keys facts
+ local_action:
+ module: vr_ssh_key_facts
+
+- name: Print the gathered facts
+ debug:
+ var: ansible_facts.vultr_ssh_key_facts
+'''
+
+RETURN = r'''
+---
+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: string
+ 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_endpoint:
+ description: Endpoint used for the API requests
+ returned: success
+ type: string
+ sample: "https://api.vultr.com"
+ansible_facts:
+ description: Response from Vultr API
+ returned: success
+ type: complex
+ contains:
+ "vultr_ssh_key_facts": [
+ {
+ "date_created": "2018-02-24 15:04:01",
+ "id": "5abf426403479",
+ "name": "me@home",
+ "ssh_key": "ssh-rsa AAAAB3Nz...NnPz me@home"
+ }
+ ]
+'''
+
+from ansible.module_utils.basic import AnsibleModule
+from ansible.module_utils.vultr import (
+ Vultr,
+ vultr_argument_spec,
+)
+
+
+class AnsibleVultrSSHKeyFacts(Vultr):
+
+ def __init__(self, module):
+ super(AnsibleVultrSSHKeyFacts, self).__init__(module, "vultr_ssh_key_facts")
+
+ self.returns = {
+ 'SSHKEYID': dict(key='id'),
+ 'name': dict(),
+ 'ssh_key': dict(),
+ 'date_created': dict(),
+ }
+
+ def get_sshkeys(self):
+ return self.api_query(path="/v1/sshkey/list")
+
+
+def parse_keys_list(keys_list):
+ return [key for id, key in keys_list.items()]
+
+
+def main():
+ argument_spec = vultr_argument_spec()
+
+ module = AnsibleModule(
+ argument_spec=argument_spec,
+ supports_check_mode=True,
+ )
+
+ sshkey_facts = AnsibleVultrSSHKeyFacts(module)
+ result = sshkey_facts.get_result(parse_keys_list(sshkey_facts.get_sshkeys()))
+ ansible_facts = {
+ 'vultr_ssh_key_facts': result['vultr_ssh_key_facts']
+ }
+ module.exit_json(ansible_facts=ansible_facts, **result)
+
+
+if __name__ == '__main__':
+ main()