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
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
|
#!/usr/bin/python
# -*- coding: utf-8 -*-
"""
Foreman management features
Copyright 2016 Guido Günther <agx@sigxcpu.org>
This software may be freely redistributed under the terms of the GNU
general public license.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
"""
DOCUMENTATION = '''
---
module: foremanhost
short_description: Manages virtual machines in Foreman
description:
- Manages virtual machines in the I(Foreman).
options:
name:
description:
- name of the machine being managed.
required: true
default: null
hostgroup:
description:
- put the machine to the given hostgroup
required: false
default: null
subnet:
description:
- put the machine into the given subnet
api_url:
description:
- foreman connection url
required: true
api_user:
description:
- foreman connection user
required: true
api_password:
description:
- foreman connection password (can also be passwed via
ANSIBLE_FOREMAN_PW)
required: false
state:
description:
- state of the machine (e.g.'present')
required: true
ssl_verify:
description:
- Wether to verify SSL certs of the Foreman API
required: false
json:
description:
- additional JSON used to define the machine
required: false
default: {}
author:
- "Guido Günther"
'''
EXAMPLES = '''
# a playbook task line:
- foremanhost: name=foobar state=present
# a playbook example of defining and creating a VM via Foreman
tasks:
- foremanhost:
name: foobar
subnet: asubnet
state: present
json: "{{ lookup('template', 'example.json') }}"
api_user: foreman
api_password: admin
api_url: http://localhost:3000/
'''
import os
import copy
from ansible.module_utils.basic import *
try:
import requests
except ImportError:
HAS_REQUESTE = False
else:
from requests.auth import HTTPBasicAuth
HAS_REQUESTS = True
FOREMAN_FAILED = 1
FOREMAN_SUCCESS = 0
def merge_json(name, hostgroup_id, image_id, compute_resource_id, subnet_id, customjson):
if customjson:
customdata = json.loads(customjson)
ret = copy.deepcopy(customdata)
if not ret.has_key('host'):
ret['host'] = {}
ret['host']['name'] = name
ret['host']['hostgroup_id'] = int(hostgroup_id)
if image_id:
ret['host']['image_id'] = int(image_id)
ret['host']['provision_method'] = "image"
ret['host']['compute_resource_id'] = int(compute_resource_id)
if subnet_id:
ret['host']['subnet_id'] = subnet_id
return ret
# Post Data to Foreman
def do_post(url, data, params):
data = None if data is None else json.dumps(data)
ret = requests.post(url,
data=data,
**params)
ret.raise_for_status()
return dict(status=ret.status_code, text=ret.text)
def do_get(url, params):
ret = requests.get(url, **params)
ret.raise_for_status()
return dict(status=ret.status_code, text=ret.text)
def do_put(url, data, params):
data = None if data is None else json.dumps(data)
ret = requests.put(url,
data=data,
**params)
ret.raise_for_status()
return dict(status=ret.status_code, text=ret.text)
def do_delete(url, params):
ret = requests.delete(url, **params)
ret.raise_for_status()
return dict(status=ret.status_code, text=ret.text)
def is_exists(e):
"""
Check if the error returned indicates an already existing entity
"""
if e.response.status_code != 422:
return False
err = json.loads(e.response.text)
try:
err_msg = err["error"]["errors"]
# Be careful to avoid IndexError so we can rethrow
# requests exception
if (err_msg.has_key("name") and
err_msg["name"] == [u'has already been taken']):
return True
except IndexError:
return False
return False
def is_absent(e):
"""
Check if the error returned indicates a missing entity
"""
if e.response.status_code == 404:
return True
return False
def item_to_id(base_url, field, name):
ret = find_item(base_url, field, name)
return '%d' % ret['id'] if ret else None
def find_item(base_url, field, name):
url = base_url + "?search=%s=\"%s\"" % (field, name)
ret = do_get(url, headers)
results = json.loads(ret['text'])['results']
if results == []:
return None
if len(results) > 1:
raise ValueError("Found more than item for '%s'" % name)
return results[0]
def find_image(compute_resource_id, image):
image_url = "%s/api/v2/compute_resources/%s/images" % (api_url, compute_resource_id)
image_id = item_to_id(image_url, 'name', image)
if not image_id:
raise ValueError("Image '%s' not found" % image)
return image_id
def find_compute_resource(compute_resource):
compute_resource_url = "%s/api/v2/compute_resources/" % api_url
compute_resource_id = item_to_id(compute_resource_url, 'name', compute_resource)
if not compute_resource_id:
raise ValueError("Compute resource '%s' not found" % compute_resource)
return compute_resource_id
def find_subnet(name):
subnet_url = "%s/api/v2/subnets/" % api_url
subnet = find_item(subnet_url, 'name', name)
if not subnet:
raise ValueError("Subnet '%s' not found" % subnet)
return subnet
def find_subnet_domains(subnet_id):
subnet_domain_url = "%s/api/subnets/%s/domains" % (api_url, subnet_id)
ret = do_get(subnet_domain_url, headers)
return json.loads(ret['text'])['results']
def find_host(host, subnet):
host_url = "%s/api/v2/hosts" % api_url
domains = find_subnet_domains(subnet['id'])
if domains == []:
return None
if len(domains) > 1:
raise ValueError("Found more than one domain for subnet '%s'" % subnet['name'])
fqdn = "%s.%s" % (host, domains[0]['name'])
host_id = item_to_id(host_url, 'name', fqdn)
if not host_id:
raise ValueError("Host '%s' not found" % host)
return host_id
def get_params(hid):
hostparam_url = "%s/api/v2/hosts/%s/parameters" % (api_url, hid)
ret = do_get(hostparam_url, headers)
return json.loads(ret['text'])['results']
def param_by_name(name, params):
"""
Lookup a parameter by name in the parameter list returned by foreman
>>> param_by_name("foo", [{"name": "foo",
... "value": "fasel"}])['value']
'fasel'
>>> param_by_name("foo", [{"name": "bla",
... "value": "fasel"}])
Traceback (most recent call last):
...
ValueError: No Param with name foo found in [{'name': 'bla', 'value': 'fasel'}]
"""
for p in params:
if p['name'] == name:
return p
raise ValueError("No Param with name %s found in %s" % (name, params))
def add_param(hid, name, value):
hostparam_url = "%s/api/v2/hosts/%s/parameters" % (api_url, hid)
p = {
"parameter": {
"name": name,
"value": value,
},
}
do_post(hostparam_url, p, headers)
def del_param(hid, name, foreman_params):
param_id = param_by_name(name, foreman_params)['id']
hostparam_url = "%s/api/v2/hosts/%s/parameters/%s" % (api_url, hid, param_id)
do_delete(hostparam_url, headers)
def update_param(hid, name, value, foreman_params):
param_id = param_by_name(name, foreman_params)['id']
hostparam_url = "%s/api/v2/hosts/%s/parameters/%s" % (api_url, hid, param_id)
p = {
"parameter": {
"name": name,
"value": value,
},
}
do_put(hostparam_url, p, headers)
def ensure_params(hid, parameters):
"""Make sure the params given match the ones tagged onto the
foreman host"""
foreman_params = get_params(hid)
new = parameters.keys()
old = [p['name'] for p in foreman_params]
changed = False
add_params = set(new) - set(old)
del_params = set(old) - set(new)
mod_params = set(new).intersection(old)
for name in add_params:
add_param(hid, name, parameters[name])
changed = True
for name in mod_params:
cur_value = param_by_name(name, foreman_params)['value']
if parameters[name] != cur_value:
update_param(hid, name, parameters[name], foreman_params)
changed = True
for name in del_params:
del_param(hid, name, foreman_params)
changed = True
return changed
def core(module):
global headers
global api_url
name = module.params.get('name', None)
hostgroup = module.params.get('hostgroup', None)
image = module.params.get('image', None)
compute_resource = module.params.get('compute_resource', None)
subnetname = module.params.get('subnet', None)
state = module.params.get('state', 'present')
customjson = module.params.get('json', None)
parameters = module.params.get('params', [])
api_url = module.params.get('api_url', None)
api_user = module.params.get('api_user', None)
api_pw = module.params.get('api_password', os.getenv("ANSIBLE_FOREMAN_PW"))
ssl_verify = module.params.get('ssl_verify', True)
image_id = None
subnet = None
changed = False
ret = {}
host_url = "%s/api/v2/hosts" % api_url
headers = { 'headers': {'Content-Type': 'application/json'},
'auth': HTTPBasicAuth(api_user, api_pw),
'verify': ssl_verify,
}
if state == 'present':
hostgroup_url = "%s/api/v2/hostgroups" % api_url
hostgroup_id = item_to_id(hostgroup_url, 'title', hostgroup)
if not hostgroup_id:
raise ValueError("Hostgroup '%s' not found for '%s'" % (hostgroup, name))
compute_resource_id = find_compute_resource(compute_resource)
if image:
image_id = find_image(compute_resource_id, image)
subnet = find_subnet(subnetname)
fulljson = merge_json(name,
hostgroup_id,
image_id,
compute_resource_id,
subnet['id'],
customjson)
try:
ret = do_post(host_url, fulljson, headers)
hid = json.loads(ret['text'])['id']
changed = True
except requests.exceptions.HTTPError as e:
if is_exists(e):
hid = item_to_id(host_url, 'name', name)
else:
try:
module.fail_json(
msg='Failed to create host %s: %s' % (name, e.response.json()['error']['full_messages'])
)
# Catch any failures to get an error message
except Exception as f:
module.fail_json(
msg='Failed to create host %s: %s (failed to parse detailed error output: %s' % (name, e, f)
)
if not hid:
if not subnet:
subnet = find_subnet(subnetname)
hid = find_host(name, subnet)
if not hid:
raise ValueError("Host %s not found" % name)
if ensure_params(hid, parameters):
changed = True
elif state == 'absent':
host_id = item_to_id(host_url, 'name', name)
if host_id is None:
ret['changed'] = False
return FOREMAN_SUCCESS, ret
try:
url = os.path.join(host_url, host_id)
ret = do_delete(url, headers)
changed = True
except requests.exceptions.HTTPError as e:
if is_absent(e):
changed = False
else:
raise
else:
raise ValueError("Unknown state %s" % state)
ret['changed'] = changed
return FOREMAN_SUCCESS, ret
def main():
module = AnsibleModule(argument_spec=dict(
name = dict(required=True),
hostgroup = dict(type='str'),
image = dict(type='str'),
compute_resource = dict(type='str'),
subnet = dict(type='str'),
params = dict(type='dict'),
json = dict(),
state = dict(default='present', choices=['present','absent']),
api_url = dict(required=True),
api_user = dict(required=True),
api_password = dict(),
ssl_verify = dict(),
))
if not HAS_REQUESTS:
module.fail_json(
msg='The `requests` module is not importable. Check the requirements.'
)
rc = FOREMAN_FAILED
try:
rc, result = core(module)
except Exception as e:
module.fail_json(msg=str(e))
if rc != 0: # something went wrong emit the msg
module.fail_json(rc=rc, msg=result)
else:
module.exit_json(**result)
if __name__ == '__main__':
# import module snippets
main()
|