1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
|
#!/usr/bin/python
# -*- coding: utf-8 -*-
# Copyright (c) 2014 Hewlett-Packard Development Company, L.P.
# Copyright (c) 2013, Benno Joy <benno@ansible.com>
# Copyright (c) 2013, John Dewey <john@dewey.ws>
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
DOCUMENTATION = '''
---
module: keypair
short_description: Add/Delete a keypair from OpenStack
author: OpenStack Ansible SIG
description:
- Add or Remove key pair from OpenStack
options:
name:
description:
- Name that has to be given to the key pair
required: true
type: str
public_key:
description:
- The public key that would be uploaded to nova and injected into VMs
upon creation.
type: str
public_key_file:
description:
- Path to local file containing ssh public key. Mutually exclusive
with public_key.
type: str
state:
description:
- Should the resource be present or absent. If state is replace and
the key exists but has different content, delete it and recreate it
with the new content.
choices: [present, absent, replace]
default: present
type: str
extends_documentation_fragment:
- openstack.cloud.openstack
'''
EXAMPLES = '''
# Creates a key pair with the running users public key
- openstack.cloud.keypair:
cloud: mordred
state: present
name: ansible_key
public_key_file: /home/me/.ssh/id_rsa.pub
# Creates a new key pair and the private key returned after the run.
- openstack.cloud.keypair:
cloud: rax-dfw
state: present
name: ansible_key
'''
RETURN = '''
keypair:
description: Dictionary describing the keypair.
returned: On success when I(state) is 'present'
type: dict
contains:
created_at:
description: Date the keypair was created
returned: success
type: str
fingerprint:
description: The short fingerprint associated with the public_key
for this keypair.
returned: success
type: str
id:
description: Unique UUID.
returned: success
type: str
is_deleted:
description: Whether the keypair is deleted or not
returned: success
type: bool
name:
description: Name given to the keypair.
returned: success
type: str
private_key:
description: The private key value for the keypair.
returned: Only when a keypair is generated for the user (e.g., when
creating one and a public key is not specified).
type: str
public_key:
description: The public key value for the keypair.
returned: success
type: str
type:
description: The type of keypair
returned: success
type: str
user_id:
description: The user id for a keypair
returned: success
type: str
'''
from ansible_collections.openstack.cloud.plugins.module_utils.openstack import (
OpenStackModule)
class KeyPairModule(OpenStackModule):
argument_spec = dict(
name=dict(required=True),
public_key=dict(),
public_key_file=dict(),
state=dict(default='present',
choices=['absent', 'present', 'replace']),
)
module_kwargs = dict(
mutually_exclusive=[['public_key', 'public_key_file']])
def _system_state_change(self, keypair):
state = self.params['state']
if state == 'present' and not keypair:
return True
if state == 'absent' and keypair:
return True
return False
def run(self):
state = self.params['state']
name = self.params['name']
public_key = self.params['public_key']
if self.params['public_key_file']:
with open(self.params['public_key_file']) as public_key_fh:
public_key = public_key_fh.read()
keypair = self.conn.compute.find_keypair(name)
if self.ansible.check_mode:
self.exit_json(changed=self._system_state_change(keypair))
changed = False
if state in ('present', 'replace'):
if keypair and keypair['name'] == name:
if public_key and (public_key != keypair['public_key']):
if state == 'present':
self.fail_json(
msg="Key name %s present but key hash not the same"
" as offered. Delete key first." % name
)
else:
self.conn.compute.delete_keypair(keypair)
keypair = self.conn.create_keypair(name, public_key)
changed = True
else:
keypair = self.conn.create_keypair(name, public_key)
changed = True
self.exit_json(
changed=changed, keypair=keypair.to_dict(computed=False))
elif state == 'absent':
if keypair:
self.conn.compute.delete_keypair(keypair)
self.exit_json(changed=True)
self.exit_json(changed=False)
def main():
module = KeyPairModule()
module()
if __name__ == '__main__':
main()
|
