Adds ipa_dnszone module (#28790)
* Adds ipa_dnszone * Use new copyright/gpl notice * Update metadata version * Use native error handling * Fix boilerplate * Remove default false * Use localhost * Should be 2.5
This commit is contained in:
Fran Fitzpatrick
ansibot
parent
55739c1e46
commit
c7760f3ea8
1 changed files with 182 additions and 0 deletions
182
lib/ansible/modules/identity/ipa/ipa_dnszone.py
Normal file
182
lib/ansible/modules/identity/ipa/ipa_dnszone.py
Normal file
|
|
@ -0,0 +1,182 @@
|
|||
#!/usr/bin/python
|
||||
# -*- coding: utf-8 -*-
|
||||
# Copyright: (c) 2017, Fran Fitzpatrick (francis.x.fitzpatrick@gmail.com)
|
||||
# Borrowed heavily from other work by Abhijeet Kasurde (akasurde@redhat.com)
|
||||
# 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 = '''
|
||||
---
|
||||
module: ipa_dnszone
|
||||
author: Fran Fitzpatrick (@fxfitz)
|
||||
short_description: Manage FreeIPA DNS Zones
|
||||
description:
|
||||
- Add and delete an IPA DNS Zones using IPA API
|
||||
options:
|
||||
zone_name:
|
||||
description:
|
||||
- The DNS zone name to which needs to be managed.
|
||||
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: localhost
|
||||
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.5"
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
# Ensure dns zone is present
|
||||
- ipa_dnsrecord:
|
||||
ipa_host: spider.example.com
|
||||
ipa_pass: Passw0rd!
|
||||
state: present
|
||||
zone_name: example.com
|
||||
|
||||
# Ensure that dns zone is removed
|
||||
- ipa_dnszone:
|
||||
zone_name: example.com
|
||||
ipa_host: localhost
|
||||
ipa_user: admin
|
||||
ipa_pass: topsecret
|
||||
state: absent
|
||||
'''
|
||||
|
||||
RETURN = '''
|
||||
zone:
|
||||
description: DNS zone as returned by IPA API.
|
||||
returned: always
|
||||
type: dict
|
||||
'''
|
||||
|
||||
from ansible.module_utils.basic import AnsibleModule
|
||||
from ansible.module_utils.ipa import IPAClient
|
||||
from ansible.module_utils._text import to_native
|
||||
|
||||
|
||||
class DNSZoneIPAClient(IPAClient):
|
||||
def __init__(self, module, host, port, protocol):
|
||||
super(DNSZoneIPAClient, self).__init__(module, host, port, protocol)
|
||||
|
||||
def dnszone_find(self, zone_name):
|
||||
return self._post_json(
|
||||
method='dnszone_find',
|
||||
name=zone_name,
|
||||
item={'idnsname': zone_name}
|
||||
)
|
||||
|
||||
def dnszone_add(self, zone_name=None, details=None):
|
||||
return self._post_json(
|
||||
method='dnszone_add',
|
||||
name=zone_name,
|
||||
item={}
|
||||
)
|
||||
|
||||
def dnszone_del(self, zone_name=None, record_name=None, details=None):
|
||||
return self._post_json(
|
||||
method='dnszone_del', name=zone_name, item={})
|
||||
|
||||
|
||||
def ensure(module, client):
|
||||
zone_name = module.params['zone_name']
|
||||
state = module.params['state']
|
||||
|
||||
ipa_dnszone = client.dnszone_find(zone_name)
|
||||
|
||||
changed = False
|
||||
if state == 'present':
|
||||
if not ipa_dnszone:
|
||||
changed = True
|
||||
if not module.check_mode:
|
||||
client.dnszone_add(zone_name=zone_name)
|
||||
else:
|
||||
changed = False
|
||||
else:
|
||||
if ipa_dnszone:
|
||||
changed = True
|
||||
if not module.check_mode:
|
||||
client.dnszone_del(zone_name=zone_name)
|
||||
|
||||
return changed, client.dnszone_find(zone_name)
|
||||
|
||||
|
||||
def main():
|
||||
module = AnsibleModule(
|
||||
argument_spec=dict(
|
||||
zone_name=dict(type='str', required=True),
|
||||
ipa_prot=dict(
|
||||
type='str',
|
||||
default='https',
|
||||
choices=['http', 'https']
|
||||
),
|
||||
ipa_host=dict(
|
||||
type='str',
|
||||
default='localhost'
|
||||
),
|
||||
state=dict(
|
||||
type='str',
|
||||
default='present',
|
||||
choices=['present', 'absent']
|
||||
),
|
||||
ipa_port=dict(type='int', default=443),
|
||||
ipa_user=dict(type='str', default='admin'),
|
||||
ipa_pass=dict(type='str', required=True, no_log=True),
|
||||
validate_certs=dict(type='bool', default=True),
|
||||
),
|
||||
supports_check_mode=True,
|
||||
)
|
||||
|
||||
client = DNSZoneIPAClient(
|
||||
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, zone = ensure(module, client)
|
||||
module.exit_json(changed=changed, zone=zone)
|
||||
except Exception as e:
|
||||
module.fail_json(msg=to_native(e))
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
||||
Loading…
Reference in a new issue