1b38b7c500
With "extends_documentation_fragment: ['openstack.cloud.openstack']" it is not necessary to list required Python libraries in section 'requirements' of DOCUMENTATION docstring in modules. Ansible will merge requirements from doc fragments and DOCUMENTATION docstring which previously resulted in duplicates such as in server module [0]: * openstacksdk * openstacksdk >= 0.36, < 0.99.0 * python >= 3.6 When removing the 'requirements' section from server module, then Ansible will list openstacksdk once only: * openstacksdk >= 0.36, < 0.99.0 * python >= 3.6 To see what documentation Ansible will produce for server module run: ansible-doc --type module openstack.cloud.server [0] https://docs.ansible.com/ansible/latest/collections/openstack/\ cloud/server_module.html Change-Id: I727ed95ee480bb644b5a533f6a9526973677064c
170 lines
4.6 KiB
Python
170 lines
4.6 KiB
Python
#!/usr/bin/python
|
|
# -*- coding: utf-8 -*-
|
|
|
|
# Copyright (c) 2021 by Open Telekom Cloud, operated by T-Systems International GmbH
|
|
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
|
|
|
|
|
DOCUMENTATION = r'''
|
|
---
|
|
module: dns_zone_info
|
|
short_description: Getting information about dns zones
|
|
author: OpenStack Ansible SIG
|
|
description:
|
|
- Getting information about dns zones. Output can be filtered.
|
|
options:
|
|
description:
|
|
description:
|
|
- Zone description.
|
|
type: str
|
|
email:
|
|
description:
|
|
- Email of the zone owner
|
|
- Only applies to primary zones.
|
|
type: str
|
|
name:
|
|
description:
|
|
- Zone name.
|
|
type: str
|
|
ttl:
|
|
description:
|
|
- TTL (Time To Live) value in seconds.
|
|
type: int
|
|
type:
|
|
description:
|
|
- Zone type.
|
|
choices: ['primary', 'secondary']
|
|
type: str
|
|
extends_documentation_fragment:
|
|
- openstack.cloud.openstack
|
|
'''
|
|
|
|
EXAMPLES = r'''
|
|
- name: Fetch all DNS zones
|
|
openstack.cloud.dns_zones:
|
|
cloud: devstack
|
|
|
|
- name: Fetch DNS zones by name
|
|
openstack.cloud.dns_zones:
|
|
cloud: devstack
|
|
name: ansible.test.zone.
|
|
'''
|
|
|
|
RETURN = r'''
|
|
zones:
|
|
description: Dictionary describing the DNS zones.
|
|
returned: On success when I(state) is C(present).
|
|
type: list
|
|
elements: dict
|
|
contains:
|
|
action:
|
|
description: Current action in progress on the resource.
|
|
type: str
|
|
sample: "CREATE"
|
|
attributes:
|
|
description: Key value pairs of information about this zone, and the
|
|
pool the user would like to place the zone in. This
|
|
information can be used by the scheduler to place zones on
|
|
the correct pool.
|
|
type: dict
|
|
sample: {"tier": "gold", "ha": "true"}
|
|
created_at:
|
|
description: Date / Time when resource was created.
|
|
type: str
|
|
sample: "2014-07-07T18:25:31.275934"
|
|
description:
|
|
description: Description for this zone.
|
|
type: str
|
|
sample: "This is an example zone."
|
|
email:
|
|
description: E-mail for the zone. Used in SOA records for the zone.
|
|
type: str
|
|
sample: "test@example.org"
|
|
id:
|
|
description: ID for the resource.
|
|
type: int
|
|
sample: "a86dba58-0043-4cc6-a1bb-69d5e86f3ca3"
|
|
links:
|
|
description: Links to the resource, and other related resources. When a
|
|
response has been broken into pages, we will include a next
|
|
link that should be followed to retrieve all results.
|
|
type: dict
|
|
sample: {"self": "https://127.0.0.1:9001/v2/zones/a86dba...d5e86f3ca3"}
|
|
masters:
|
|
description: The servers to slave from to get DNS information.
|
|
Mandatory for secondary zones.
|
|
type: list
|
|
sample: "[]"
|
|
name:
|
|
description: DNS Name for the zone.
|
|
type: str
|
|
sample: "test.test."
|
|
pool_id:
|
|
description: ID for the pool hosting this zone.
|
|
type: str
|
|
sample: "a86dba58-0043-4cc6-a1bb-69d5e86f3ca3"
|
|
project_id:
|
|
description: ID for the project that owns the resource.
|
|
type: str
|
|
sample: "4335d1f0-f793-11e2-b778-0800200c9a66"
|
|
serial:
|
|
description: Current serial number for the zone.
|
|
type: int
|
|
sample: 1404757531
|
|
status:
|
|
description: Status of the resource.
|
|
type: str
|
|
sample: "ACTIVE"
|
|
ttl:
|
|
description: TTL (Time to Live) for the zone.
|
|
type: int
|
|
sample: 7200
|
|
type:
|
|
description: Type of zone. PRIMARY is controlled by Designate,
|
|
SECONDARY zones are slaved from another DNS Server.
|
|
Defaults to PRIMARY.
|
|
type: str
|
|
sample: "PRIMARY"
|
|
updated_at:
|
|
description: Date / Time when resource last updated.
|
|
type: str
|
|
sample: "2014-07-07T18:25:31.275934"
|
|
'''
|
|
|
|
from ansible_collections.openstack.cloud.plugins.module_utils.openstack import OpenStackModule
|
|
|
|
|
|
class DnsZoneInfoModule(OpenStackModule):
|
|
|
|
argument_spec = dict(
|
|
description=dict(),
|
|
email=dict(),
|
|
name=dict(),
|
|
ttl=dict(type='int'),
|
|
type=dict(choices=['primary', 'secondary']),
|
|
)
|
|
module_kwargs = dict(
|
|
supports_check_mode=True
|
|
)
|
|
|
|
def run(self):
|
|
kwargs = dict((k, self.params[k])
|
|
for k in ['description', 'email', 'name',
|
|
'ttl', 'type']
|
|
if self.params[k] is not None)
|
|
|
|
zones = self.conn.dns.zones(**kwargs)
|
|
|
|
self.exit_json(
|
|
changed=False,
|
|
zones=[z.to_dict(computed=False) for z in zones])
|
|
|
|
|
|
def main():
|
|
module = DnsZoneInfoModule()
|
|
module()
|
|
|
|
|
|
if __name__ == '__main__':
|
|
main()
|