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/rackspace/rax_keypair.py

174 lines
4.8 KiB
Python
Raw Normal View History

2020-03-09 10:11:07 +01:00
#!/usr/bin/python
# -*- coding: utf-8 -*-
# Copyright Ansible Project
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
# SPDX-License-Identifier: GPL-3.0-or-later
2020-03-09 10:11:07 +01:00
from __future__ import absolute_import, division, print_function
__metaclass__ = type
DOCUMENTATION = '''
---
module: rax_keypair
short_description: Create a keypair for use with Rackspace Cloud Servers
description:
- Create a keypair for use with Rackspace Cloud Servers
options:
name:
Tidy up validate-modules ignores for rackspace modules (#1242) * fixed validation-modules for plugins/doc_fragments/rackspace.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_cbs.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_cbs_attachments.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_cdb_database.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_cdb.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_cdb_user.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_clb_nodes.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_clb.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_clb_ssl.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_dns.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_dns_record.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_facts.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_files.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_files_objects.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_identity.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_keypair.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_meta.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_mon_alarm.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_mon_check.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_mon_entity.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_mon_notification_plan.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_mon_notification.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_network.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_queue.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_scaling_group.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_scaling_policy.py * Enabling validation-modules for rackspace modules * Removed test in rax.py * Added markup to items in list * rax_monm_check.py: moved choices doc to description for check_type As the argument_spec does not contain the "choices" spec, adjusting that in the docs * rax_monm_check.py: a number of things missing in docs, fixed
2020-11-08 09:44:28 +01:00
type: str
2020-03-09 10:11:07 +01:00
description:
- Name of keypair
required: true
public_key:
Tidy up validate-modules ignores for rackspace modules (#1242) * fixed validation-modules for plugins/doc_fragments/rackspace.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_cbs.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_cbs_attachments.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_cdb_database.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_cdb.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_cdb_user.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_clb_nodes.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_clb.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_clb_ssl.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_dns.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_dns_record.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_facts.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_files.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_files_objects.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_identity.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_keypair.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_meta.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_mon_alarm.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_mon_check.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_mon_entity.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_mon_notification_plan.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_mon_notification.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_network.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_queue.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_scaling_group.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_scaling_policy.py * Enabling validation-modules for rackspace modules * Removed test in rax.py * Added markup to items in list * rax_monm_check.py: moved choices doc to description for check_type As the argument_spec does not contain the "choices" spec, adjusting that in the docs * rax_monm_check.py: a number of things missing in docs, fixed
2020-11-08 09:44:28 +01:00
type: str
2020-03-09 10:11:07 +01:00
description:
- Public Key string to upload. Can be a file path or string
state:
Tidy up validate-modules ignores for rackspace modules (#1242) * fixed validation-modules for plugins/doc_fragments/rackspace.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_cbs.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_cbs_attachments.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_cdb_database.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_cdb.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_cdb_user.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_clb_nodes.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_clb.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_clb_ssl.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_dns.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_dns_record.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_facts.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_files.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_files_objects.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_identity.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_keypair.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_meta.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_mon_alarm.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_mon_check.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_mon_entity.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_mon_notification_plan.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_mon_notification.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_network.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_queue.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_scaling_group.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_scaling_policy.py * Enabling validation-modules for rackspace modules * Removed test in rax.py * Added markup to items in list * rax_monm_check.py: moved choices doc to description for check_type As the argument_spec does not contain the "choices" spec, adjusting that in the docs * rax_monm_check.py: a number of things missing in docs, fixed
2020-11-08 09:44:28 +01:00
type: str
2020-03-09 10:11:07 +01:00
description:
- Indicate desired state of the resource
choices:
- present
- absent
default: present
author: "Matt Martz (@sivel)"
notes:
- Keypairs cannot be manipulated, only created and deleted. To "update" a
keypair you must first delete and then recreate.
- The ability to specify a file path for the public key was added in 1.7
extends_documentation_fragment:
- community.general.rackspace.openstack
'''
EXAMPLES = '''
- name: Create a keypair
hosts: localhost
gather_facts: False
tasks:
2020-05-16 15:07:51 +02:00
- name: Keypair request
2020-03-09 10:11:07 +01:00
local_action:
module: rax_keypair
credentials: ~/.raxpub
name: my_keypair
region: DFW
register: keypair
- name: Create local public key
local_action:
module: copy
content: "{{ keypair.keypair.public_key }}"
dest: "{{ inventory_dir }}/{{ keypair.keypair.name }}.pub"
- name: Create local private key
local_action:
module: copy
content: "{{ keypair.keypair.private_key }}"
dest: "{{ inventory_dir }}/{{ keypair.keypair.name }}"
- name: Create a keypair
hosts: localhost
gather_facts: False
tasks:
2020-05-16 15:07:51 +02:00
- name: Keypair request
2020-03-09 10:11:07 +01:00
local_action:
module: rax_keypair
credentials: ~/.raxpub
name: my_keypair
public_key: "{{ lookup('file', 'authorized_keys/id_rsa.pub') }}"
region: DFW
register: keypair
'''
import os
try:
import pyrax
HAS_PYRAX = True
except ImportError:
HAS_PYRAX = False
from ansible.module_utils.basic import AnsibleModule
from ansible_collections.community.general.plugins.module_utils.rax import (rax_argument_spec,
rax_required_together,
rax_to_dict,
setup_rax_module,
)
2020-03-09 10:11:07 +01:00
def rax_keypair(module, name, public_key, state):
changed = False
cs = pyrax.cloudservers
if cs is None:
module.fail_json(msg='Failed to instantiate client. This '
'typically indicates an invalid region or an '
'incorrectly capitalized region name.')
keypair = {}
if state == 'present':
if public_key and os.path.isfile(public_key):
try:
f = open(public_key)
public_key = f.read()
f.close()
except Exception as e:
module.fail_json(msg='Failed to load %s' % public_key)
try:
keypair = cs.keypairs.find(name=name)
except cs.exceptions.NotFound:
try:
keypair = cs.keypairs.create(name, public_key)
changed = True
except Exception as e:
module.fail_json(msg='%s' % e.message)
except Exception as e:
module.fail_json(msg='%s' % e.message)
elif state == 'absent':
try:
keypair = cs.keypairs.find(name=name)
except Exception:
pass
if keypair:
try:
keypair.delete()
changed = True
except Exception as e:
module.fail_json(msg='%s' % e.message)
module.exit_json(changed=changed, keypair=rax_to_dict(keypair))
def main():
argument_spec = rax_argument_spec()
argument_spec.update(
dict(
name=dict(required=True),
public_key=dict(),
state=dict(default='present', choices=['absent', 'present']),
)
)
module = AnsibleModule(
argument_spec=argument_spec,
required_together=rax_required_together(),
)
if not HAS_PYRAX:
module.fail_json(msg='pyrax is required for this module')
name = module.params.get('name')
public_key = module.params.get('public_key')
state = module.params.get('state')
setup_rax_module(module, pyrax)
rax_keypair(module, name, public_key, state)
if __name__ == '__main__':
main()