mirror of
https://opendev.org/openstack/ansible-collections-openstack.git
synced 2026-05-06 13:23:06 +00:00
Rename all of the modules
This is separate from the previous patch - it's just the results of running the script so we can review the two a little independently. We should probably squash them. Change-Id: I838f15cf4a32455a5be20033c8ddc27db6ca15c0
This commit is contained in:
Monty Taylor
241
plugins/modules/recordset.py
Normal file
241
plugins/modules/recordset.py
Normal file
@@ -0,0 +1,241 @@
|
||||
#!/usr/bin/python
|
||||
# Copyright (c) 2016 Hewlett-Packard Enterprise
|
||||
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
|
||||
|
||||
ANSIBLE_METADATA = {'metadata_version': '1.1',
|
||||
'status': ['preview'],
|
||||
'supported_by': 'community'}
|
||||
|
||||
|
||||
DOCUMENTATION = '''
|
||||
---
|
||||
module: recordset
|
||||
short_description: Manage OpenStack DNS recordsets
|
||||
author: "Ricardo Carrillo Cruz (@rcarrillocruz)"
|
||||
description:
|
||||
- Manage OpenStack DNS recordsets. Recordsets can be created, deleted or
|
||||
updated. Only the I(records), I(description), and I(ttl) values
|
||||
can be updated.
|
||||
options:
|
||||
zone:
|
||||
description:
|
||||
- Zone managing the recordset
|
||||
required: true
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- Name of the recordset
|
||||
required: true
|
||||
type: str
|
||||
recordset_type:
|
||||
description:
|
||||
- Recordset type
|
||||
- Required when I(state=present).
|
||||
type: str
|
||||
records:
|
||||
description:
|
||||
- List of recordset definitions.
|
||||
- Required when I(state=present).
|
||||
type: list
|
||||
elements: str
|
||||
description:
|
||||
description:
|
||||
- Description of the recordset
|
||||
type: str
|
||||
ttl:
|
||||
description:
|
||||
- TTL (Time To Live) value in seconds
|
||||
type: int
|
||||
state:
|
||||
description:
|
||||
- Should the resource be present or absent.
|
||||
choices: [present, absent]
|
||||
default: present
|
||||
type: str
|
||||
requirements:
|
||||
- "python >= 3.6"
|
||||
- "openstacksdk"
|
||||
|
||||
extends_documentation_fragment:
|
||||
- openstack.cloud.openstack
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
# Create a recordset named "www.example.net."
|
||||
- openstack.cloud.recordset:
|
||||
cloud: mycloud
|
||||
state: present
|
||||
zone: example.net.
|
||||
name: www
|
||||
recordset_type: primary
|
||||
records: ['10.1.1.1']
|
||||
description: test recordset
|
||||
ttl: 3600
|
||||
|
||||
# Update the TTL on existing "www.example.net." recordset
|
||||
- openstack.cloud.recordset:
|
||||
cloud: mycloud
|
||||
state: present
|
||||
zone: example.net.
|
||||
name: www
|
||||
ttl: 7200
|
||||
|
||||
# Delete recordset named "www.example.net."
|
||||
- openstack.cloud.recordset:
|
||||
cloud: mycloud
|
||||
state: absent
|
||||
zone: example.net.
|
||||
name: www
|
||||
'''
|
||||
|
||||
RETURN = '''
|
||||
recordset:
|
||||
description: Dictionary describing the recordset.
|
||||
returned: On success when I(state) is 'present'.
|
||||
type: complex
|
||||
contains:
|
||||
id:
|
||||
description: Unique recordset ID
|
||||
type: str
|
||||
sample: "c1c530a3-3619-46f3-b0f6-236927b2618c"
|
||||
name:
|
||||
description: Recordset name
|
||||
type: str
|
||||
sample: "www.example.net."
|
||||
zone_id:
|
||||
description: Zone id
|
||||
type: str
|
||||
sample: 9508e177-41d8-434e-962c-6fe6ca880af7
|
||||
type:
|
||||
description: Recordset type
|
||||
type: str
|
||||
sample: "A"
|
||||
description:
|
||||
description: Recordset description
|
||||
type: str
|
||||
sample: "Test description"
|
||||
ttl:
|
||||
description: Zone TTL value
|
||||
type: int
|
||||
sample: 3600
|
||||
records:
|
||||
description: Recordset records
|
||||
type: list
|
||||
sample: ['10.0.0.1']
|
||||
'''
|
||||
|
||||
from ansible.module_utils.basic import AnsibleModule
|
||||
from ansible_collections.openstack.cloud.plugins.module_utils.openstack import (openstack_full_argument_spec,
|
||||
openstack_module_kwargs,
|
||||
openstack_cloud_from_module)
|
||||
|
||||
|
||||
def _system_state_change(state, records, description, ttl, zone, recordset):
|
||||
if state == 'present':
|
||||
if recordset is None:
|
||||
return True
|
||||
if records is not None and recordset['records'] != records:
|
||||
return True
|
||||
if description is not None and recordset['description'] != description:
|
||||
return True
|
||||
if ttl is not None and recordset['ttl'] != ttl:
|
||||
return True
|
||||
if state == 'absent' and recordset:
|
||||
return True
|
||||
return False
|
||||
|
||||
|
||||
def main():
|
||||
argument_spec = openstack_full_argument_spec(
|
||||
zone=dict(required=True),
|
||||
name=dict(required=True),
|
||||
recordset_type=dict(required=False),
|
||||
records=dict(required=False, type='list', elements='str'),
|
||||
description=dict(required=False, default=None),
|
||||
ttl=dict(required=False, default=None, type='int'),
|
||||
state=dict(default='present', choices=['absent', 'present']),
|
||||
)
|
||||
|
||||
module_kwargs = openstack_module_kwargs()
|
||||
module = AnsibleModule(argument_spec,
|
||||
required_if=[
|
||||
('state', 'present',
|
||||
['recordset_type', 'records'])],
|
||||
supports_check_mode=True,
|
||||
**module_kwargs)
|
||||
|
||||
zone = module.params.get('zone')
|
||||
name = module.params.get('name')
|
||||
state = module.params.get('state')
|
||||
|
||||
sdk, cloud = openstack_cloud_from_module(module)
|
||||
try:
|
||||
recordset_type = module.params.get('recordset_type')
|
||||
recordset_filter = {'type': recordset_type}
|
||||
|
||||
recordsets = cloud.search_recordsets(zone, name_or_id=name, filters=recordset_filter)
|
||||
|
||||
if len(recordsets) == 1:
|
||||
recordset = recordsets[0]
|
||||
try:
|
||||
recordset_id = recordset['id']
|
||||
except KeyError as e:
|
||||
module.fail_json(msg=str(e))
|
||||
else:
|
||||
# recordsets is filtered by type and should never be more than 1 return
|
||||
recordset = None
|
||||
|
||||
if state == 'present':
|
||||
records = module.params.get('records')
|
||||
description = module.params.get('description')
|
||||
ttl = module.params.get('ttl')
|
||||
|
||||
if module.check_mode:
|
||||
module.exit_json(changed=_system_state_change(state,
|
||||
records, description,
|
||||
ttl, zone,
|
||||
recordset))
|
||||
|
||||
if recordset is None:
|
||||
recordset = cloud.create_recordset(
|
||||
zone=zone, name=name, recordset_type=recordset_type,
|
||||
records=records, description=description, ttl=ttl)
|
||||
changed = True
|
||||
else:
|
||||
if records is None:
|
||||
records = []
|
||||
|
||||
pre_update_recordset = recordset
|
||||
changed = _system_state_change(state, records,
|
||||
description, ttl,
|
||||
zone, pre_update_recordset)
|
||||
if changed:
|
||||
zone = cloud.update_recordset(
|
||||
zone, recordset_id,
|
||||
records=records,
|
||||
description=description,
|
||||
ttl=ttl)
|
||||
|
||||
module.exit_json(changed=changed, recordset=recordset)
|
||||
|
||||
elif state == 'absent':
|
||||
if module.check_mode:
|
||||
module.exit_json(changed=_system_state_change(state,
|
||||
None, None,
|
||||
None,
|
||||
None, recordset))
|
||||
|
||||
if recordset is None:
|
||||
changed = False
|
||||
else:
|
||||
cloud.delete_recordset(zone, recordset_id)
|
||||
changed = True
|
||||
module.exit_json(changed=changed)
|
||||
|
||||
except sdk.exceptions.OpenStackCloudException as e:
|
||||
module.fail_json(msg=str(e))
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
||||
Reference in New Issue
Block a user