summaryrefslogtreecommitdiffstats
path: root/collections-debian-merged/ansible_collections/openstack/cloud/plugins/modules/os_zone.py
blob: 98cf655e3fcd74b3b60b764f5a47443a55edc250 (plain)
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
#!/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)

DOCUMENTATION = '''
---
module: dns_zone
short_description: Manage OpenStack DNS zones
author: OpenStack Ansible SIG
description:
    - Manage OpenStack DNS zones. Zones can be created, deleted or
      updated. Only the I(email), I(description), I(ttl) and I(masters) values
      can be updated.
options:
   name:
     description:
        - Zone name
     required: true
     type: str
   zone_type:
     description:
        - Zone type
     choices: [primary, secondary]
     type: str
   email:
     description:
        - Email of the zone owner (only applies if zone_type is primary)
     type: str
   description:
     description:
        - Zone description
     type: str
   ttl:
     description:
        -  TTL (Time To Live) value in seconds
     type: int
   masters:
     description:
        - Master nameservers (only applies if zone_type is secondary)
     type: list
     elements: str
   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 zone named "example.net"
- openstack.cloud.dns_zone:
    cloud: mycloud
    state: present
    name: example.net.
    zone_type: primary
    email: test@example.net
    description: Test zone
    ttl: 3600

# Update the TTL on existing "example.net." zone
- openstack.cloud.dns_zone:
    cloud: mycloud
    state: present
    name: example.net.
    ttl: 7200

# Delete zone named "example.net."
- openstack.cloud.dns_zone:
    cloud: mycloud
    state: absent
    name: example.net.
'''

RETURN = '''
zone:
    description: Dictionary describing the zone.
    returned: On success when I(state) is 'present'.
    type: complex
    contains:
        id:
            description: Unique zone ID
            type: str
            sample: "c1c530a3-3619-46f3-b0f6-236927b2618c"
        name:
            description: Zone name
            type: str
            sample: "example.net."
        type:
            description: Zone type
            type: str
            sample: "PRIMARY"
        email:
            description: Zone owner email
            type: str
            sample: "test@example.net"
        description:
            description: Zone description
            type: str
            sample: "Test description"
        ttl:
            description: Zone TTL value
            type: int
            sample: 3600
        masters:
            description: Zone master nameservers
            type: list
            sample: []
'''

from ansible_collections.openstack.cloud.plugins.module_utils.openstack import OpenStackModule


class DnsZoneModule(OpenStackModule):

    argument_spec = dict(
        name=dict(required=True, type='str'),
        zone_type=dict(required=False, choices=['primary', 'secondary'], type='str'),
        email=dict(required=False, type='str'),
        description=dict(required=False, type='str'),
        ttl=dict(required=False, type='int'),
        masters=dict(required=False, type='list', elements='str'),
        state=dict(default='present', choices=['absent', 'present'], type='str'),
    )

    def _system_state_change(self, state, email, description, ttl, masters, zone):
        if state == 'present':
            if not zone:
                return True
            if email is not None and zone.email != email:
                return True
            if description is not None and zone.description != description:
                return True
            if ttl is not None and zone.ttl != ttl:
                return True
            if masters is not None and zone.masters != masters:
                return True
        if state == 'absent' and zone:
            return True
        return False

    def _wait(self, timeout, zone, state):
        """Wait for a zone to reach the desired state for the given state."""

        for count in self.sdk.utils.iterate_timeout(
                timeout,
                "Timeout waiting for zone to be %s" % state):

            if (state == 'absent' and zone is None) or (state == 'present' and zone and zone.status == 'ACTIVE'):
                return

            try:
                zone = self.conn.get_zone(zone.id)
            except Exception:
                continue

            if zone and zone.status == 'ERROR':
                self.fail_json(msg="Zone reached ERROR state while waiting for it to be %s" % state)

    def run(self):

        name = self.params['name']
        state = self.params['state']
        wait = self.params['wait']
        timeout = self.params['timeout']

        zone = self.conn.get_zone(name)

        if state == 'present':

            zone_type = self.params['zone_type']
            email = self.params['email']
            description = self.params['description']
            ttl = self.params['ttl']
            masters = self.params['masters']

            kwargs = {}

            if email:
                kwargs['email'] = email
            if description:
                kwargs['description'] = description
            if ttl:
                kwargs['ttl'] = ttl
            if masters:
                kwargs['masters'] = masters

            if self.ansible.check_mode:
                self.exit_json(changed=self._system_state_change(state, email,
                                                                 description, ttl,
                                                                 masters, zone))

            if zone is None:
                zone = self.conn.create_zone(
                    name=name, zone_type=zone_type, **kwargs)
                changed = True
            else:
                if masters is None:
                    masters = []

                pre_update_zone = zone
                changed = self._system_state_change(state, email,
                                                    description, ttl,
                                                    masters, pre_update_zone)
                if changed:
                    zone = self.conn.update_zone(
                        name, **kwargs)

            if wait:
                self._wait(timeout, zone, state)

            self.exit_json(changed=changed, zone=zone)

        elif state == 'absent':
            if self.ansible.check_mode:
                self.exit_json(changed=self._system_state_change(state, None,
                                                                 None, None,
                                                                 None, zone))

            if zone is None:
                changed = False
            else:
                self.conn.delete_zone(name)
                changed = True

            if wait:
                self._wait(timeout, zone, state)

            self.exit_json(changed=changed)


def main():
    module = DnsZoneModule()
    module()


if __name__ == '__main__':
    main()