Add FreeIPA module for managing DNS records (#25203)
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
This commit is contained in:
Abhijeet Kasurde
René Moser
parent
5b03e55440
commit
26349033c1
1 changed files with 238 additions and 0 deletions
238
lib/ansible/modules/identity/ipa/ipa_dnsrecord.py
Normal file
238
lib/ansible/modules/identity/ipa/ipa_dnsrecord.py
Normal file
|
|
@ -0,0 +1,238 @@
|
||||||
|
#!/usr/bin/python
|
||||||
|
# -*- coding: utf-8 -*-
|
||||||
|
# (c) 2017, Abhijeet Kasurde (akasurde@redhat.com)
|
||||||
|
#
|
||||||
|
# This file is part of Ansible
|
||||||
|
#
|
||||||
|
# Ansible is free software: you can redistribute it and/or modify
|
||||||
|
# it under the terms of the GNU General Public License as published by
|
||||||
|
# the Free Software Foundation, either version 3 of the License, or
|
||||||
|
# (at your option) any later version.
|
||||||
|
#
|
||||||
|
# Ansible is distributed in the hope that it will be useful,
|
||||||
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
# GNU General Public License for more details.
|
||||||
|
#
|
||||||
|
# You should have received a copy of the GNU General Public License
|
||||||
|
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
|
||||||
|
ANSIBLE_METADATA = {
|
||||||
|
'metadata_version': '1.0',
|
||||||
|
'status': ['preview'],
|
||||||
|
'supported_by': 'community'
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
DOCUMENTATION = '''
|
||||||
|
---
|
||||||
|
module: ipa_dnsrecord
|
||||||
|
author: Abhijeet Kasurde (@akasurde)
|
||||||
|
short_description: Manage FreeIPA DNS records
|
||||||
|
description:
|
||||||
|
- Add, modify and delete an IPA DNS Record using IPA API
|
||||||
|
options:
|
||||||
|
zone_name:
|
||||||
|
description:
|
||||||
|
- The DNS zone name to which DNS record needs to be managed.
|
||||||
|
required: true
|
||||||
|
record_name:
|
||||||
|
description:
|
||||||
|
- The DNS record name to manage.
|
||||||
|
required: true
|
||||||
|
aliases: ["name"]
|
||||||
|
record_type:
|
||||||
|
description:
|
||||||
|
- The type of DNS record name
|
||||||
|
- Currently, 'A', 'AAAA' is supported
|
||||||
|
required: false
|
||||||
|
default: 'A'
|
||||||
|
choices: ['A', 'AAAA']
|
||||||
|
record_ip:
|
||||||
|
description:
|
||||||
|
- Manage DNS record name with this IP address.
|
||||||
|
required: true
|
||||||
|
state:
|
||||||
|
description: State to ensure
|
||||||
|
required: false
|
||||||
|
default: present
|
||||||
|
choices: ["present", "absent"]
|
||||||
|
ipa_port:
|
||||||
|
description: Port of IPA server
|
||||||
|
required: false
|
||||||
|
default: 443
|
||||||
|
ipa_host:
|
||||||
|
description: IP or hostname of IPA server
|
||||||
|
required: false
|
||||||
|
default: ipa.example.com
|
||||||
|
ipa_user:
|
||||||
|
description: Administrative account used on IPA server
|
||||||
|
required: false
|
||||||
|
default: admin
|
||||||
|
ipa_pass:
|
||||||
|
description: Password of administrative user
|
||||||
|
required: true
|
||||||
|
ipa_prot:
|
||||||
|
description: Protocol used by IPA server
|
||||||
|
required: false
|
||||||
|
default: https
|
||||||
|
choices: ["http", "https"]
|
||||||
|
validate_certs:
|
||||||
|
description:
|
||||||
|
- This only applies if C(ipa_prot) is I(https).
|
||||||
|
- If set to C(no), the SSL certificates will not be validated.
|
||||||
|
- This should only set to C(no) used on personally controlled sites using self-signed certificates.
|
||||||
|
required: false
|
||||||
|
default: true
|
||||||
|
version_added: "2.4"
|
||||||
|
'''
|
||||||
|
|
||||||
|
EXAMPLES = '''
|
||||||
|
# Ensure dns record is present
|
||||||
|
- ipa_dnsrecord:
|
||||||
|
ipa_host: spider.example.com
|
||||||
|
ipa_pass: Passw0rd!
|
||||||
|
state: present
|
||||||
|
zone_name: example.com
|
||||||
|
record_name: vm-001
|
||||||
|
record_type: 'AAAA'
|
||||||
|
record_ip: '::1'
|
||||||
|
|
||||||
|
# Ensure that dns record is removed
|
||||||
|
- ipa_dnsrecord:
|
||||||
|
name: host01
|
||||||
|
zone_name: example.com
|
||||||
|
record_type: 'AAAA'
|
||||||
|
record_ip: '::1'
|
||||||
|
ipa_host: ipa.example.com
|
||||||
|
ipa_user: admin
|
||||||
|
ipa_pass: topsecret
|
||||||
|
state: absent
|
||||||
|
'''
|
||||||
|
|
||||||
|
RETURN = '''
|
||||||
|
dnsrecord:
|
||||||
|
description: DNS record as returned by IPA API.
|
||||||
|
returned: always
|
||||||
|
type: dict
|
||||||
|
'''
|
||||||
|
|
||||||
|
from ansible.module_utils.basic import AnsibleModule
|
||||||
|
from ansible.module_utils.pycompat24 import get_exception
|
||||||
|
from ansible.module_utils.ipa import IPAClient
|
||||||
|
|
||||||
|
|
||||||
|
class DNSRecordIPAClient(IPAClient):
|
||||||
|
def __init__(self, module, host, port, protocol):
|
||||||
|
super(DNSRecordIPAClient, self).__init__(module, host, port, protocol)
|
||||||
|
|
||||||
|
def dnsrecord_find(self, zone_name, record_name):
|
||||||
|
return self._post_json(method='dnsrecord_find', name=zone_name, item={'idnsname': record_name})
|
||||||
|
|
||||||
|
def dnsrecord_add(self, zone_name=None, record_name=None, details=None):
|
||||||
|
item = dict(idnsname=record_name)
|
||||||
|
if details['record_type'] == 'A':
|
||||||
|
item.update(a_part_ip_address=details['record_ip'])
|
||||||
|
elif details['record_type'] == 'AAAA':
|
||||||
|
item.update(aaaa_part_ip_address=details['record_ip'])
|
||||||
|
|
||||||
|
return self._post_json(method='dnsrecord_add', name=zone_name, item=item)
|
||||||
|
|
||||||
|
def dnsrecord_mod(self, zone_name=None, record_name=None, details=None):
|
||||||
|
item = get_dnsrecord_dict(details)
|
||||||
|
item.update(idnsname=record_name)
|
||||||
|
return self._post_json(method='dnsrecord_mod', name=zone_name, item=item)
|
||||||
|
|
||||||
|
def dnsrecord_del(self, zone_name=None, record_name=None, details=None):
|
||||||
|
item = get_dnsrecord_dict(details)
|
||||||
|
item.update(idnsname=record_name)
|
||||||
|
return self._post_json(method='dnsrecord_del', name=zone_name, item=item)
|
||||||
|
|
||||||
|
|
||||||
|
def get_dnsrecord_dict(details=None):
|
||||||
|
module_dnsrecord = dict()
|
||||||
|
if details['record_type'] == 'A' and details['record_ip']:
|
||||||
|
module_dnsrecord.update(arecord=details['record_ip'])
|
||||||
|
elif details['record_type'] == 'AAAA' and details['record_ip']:
|
||||||
|
module_dnsrecord.update(aaaarecord=details['record_ip'])
|
||||||
|
return module_dnsrecord
|
||||||
|
|
||||||
|
|
||||||
|
def get_dnsrecord_diff(client, ipa_dnsrecord, module_dnsrecord):
|
||||||
|
details = get_dnsrecord_dict(module_dnsrecord)
|
||||||
|
return client.get_diff(ipa_data=ipa_dnsrecord, module_data=details)
|
||||||
|
|
||||||
|
|
||||||
|
def ensure(module, client):
|
||||||
|
zone_name = module.params['zone_name']
|
||||||
|
record_name = module.params['record_name']
|
||||||
|
state = module.params['state']
|
||||||
|
|
||||||
|
ipa_dnsrecord = client.dnsrecord_find(zone_name, record_name)
|
||||||
|
module_dnsrecord = dict(record_type=module.params['record_type'],
|
||||||
|
record_ip=module.params['record_ip'])
|
||||||
|
|
||||||
|
changed = False
|
||||||
|
if state == 'present':
|
||||||
|
if not ipa_dnsrecord:
|
||||||
|
changed = True
|
||||||
|
if not module.check_mode:
|
||||||
|
client.dnsrecord_add(zone_name=zone_name,
|
||||||
|
record_name=record_name,
|
||||||
|
details=module_dnsrecord)
|
||||||
|
else:
|
||||||
|
diff = get_dnsrecord_diff(client, ipa_dnsrecord, module_dnsrecord)
|
||||||
|
if len(diff) > 0:
|
||||||
|
changed = True
|
||||||
|
if not module.check_mode:
|
||||||
|
client.dnsrecord_mod(zone_name=zone_name,
|
||||||
|
record_name=record_name,
|
||||||
|
details=module_dnsrecord)
|
||||||
|
else:
|
||||||
|
if ipa_dnsrecord:
|
||||||
|
changed = True
|
||||||
|
if not module.check_mode:
|
||||||
|
client.dnsrecord_del(zone_name=zone_name,
|
||||||
|
record_name=record_name,
|
||||||
|
details=module_dnsrecord)
|
||||||
|
|
||||||
|
return changed, client.dnsrecord_find(zone_name, record_name)
|
||||||
|
|
||||||
|
|
||||||
|
def main():
|
||||||
|
record_types = ['A', 'AAAA']
|
||||||
|
module = AnsibleModule(
|
||||||
|
argument_spec=dict(
|
||||||
|
zone_name=dict(type='str', required=True),
|
||||||
|
record_name=dict(type='str', required=True, aliases=['name']),
|
||||||
|
record_type=dict(type='str', required=False, default='A', choices=record_types),
|
||||||
|
record_ip=dict(type='str', required=True),
|
||||||
|
state=dict(type='str', required=False, default='present', choices=['present', 'absent']),
|
||||||
|
ipa_prot=dict(type='str', required=False, default='https', choices=['http', 'https']),
|
||||||
|
ipa_host=dict(type='str', required=False, default='ipa.example.com'),
|
||||||
|
ipa_port=dict(type='int', required=False, default=443),
|
||||||
|
ipa_user=dict(type='str', required=False, default='admin'),
|
||||||
|
ipa_pass=dict(type='str', required=True, no_log=True),
|
||||||
|
validate_certs=dict(type='bool', required=False, default=True),
|
||||||
|
),
|
||||||
|
supports_check_mode=True,
|
||||||
|
)
|
||||||
|
|
||||||
|
client = DNSRecordIPAClient(module=module,
|
||||||
|
host=module.params['ipa_host'],
|
||||||
|
port=module.params['ipa_port'],
|
||||||
|
protocol=module.params['ipa_prot'])
|
||||||
|
|
||||||
|
try:
|
||||||
|
client.login(username=module.params['ipa_user'],
|
||||||
|
password=module.params['ipa_pass'])
|
||||||
|
changed, record = ensure(module, client)
|
||||||
|
module.exit_json(changed=changed, record=record)
|
||||||
|
except Exception:
|
||||||
|
e = get_exception()
|
||||||
|
module.fail_json(msg=str(e))
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == '__main__':
|
||||||
|
main()
|
||||||
Loading…
Reference in a new issue