summaryrefslogtreecommitdiff
path: root/lib/ansible/modules/cloud/hcloud/hcloud_rdns.py
diff options
context:
space:
mode:
Diffstat (limited to 'lib/ansible/modules/cloud/hcloud/hcloud_rdns.py')
-rw-r--r--lib/ansible/modules/cloud/hcloud/hcloud_rdns.py230
1 files changed, 0 insertions, 230 deletions
diff --git a/lib/ansible/modules/cloud/hcloud/hcloud_rdns.py b/lib/ansible/modules/cloud/hcloud/hcloud_rdns.py
deleted file mode 100644
index db17c77485..0000000000
--- a/lib/ansible/modules/cloud/hcloud/hcloud_rdns.py
+++ /dev/null
@@ -1,230 +0,0 @@
-#!/usr/bin/python
-# -*- coding: utf-8 -*-
-
-# Copyright: (c) 2019, Hetzner Cloud GmbH <info@hetzner-cloud.de>
-# 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: hcloud_rdns
-
-short_description: Create and manage reverse DNS entries on the Hetzner Cloud.
-
-version_added: "2.9"
-
-description:
- - Create, update and delete reverse DNS entries on the Hetzner Cloud.
-
-author:
- - Lukas Kaemmerling (@lkaemmerling)
-
-options:
- server:
- description:
- - The name of the Hetzner Cloud server you want to add the reverse DNS entry to.
- type: str
- required: true
- ip_address:
- description:
- - The IP address that should point to I(dns_ptr).
- type: str
- required: true
- dns_ptr:
- description:
- - The DNS address the I(ip_address) should resolve to.
- - Omit the param to reset the reverse DNS entry to the default value.
- type: str
- state:
- description:
- - State of the reverse DNS entry.
- default: present
- choices: [ absent, present ]
- type: str
-
-requirements:
- - hcloud-python >= 1.3.0
-
-extends_documentation_fragment: hcloud
-"""
-
-EXAMPLES = """
-- name: Create a reverse DNS entry for a server
- hcloud_rdns:
- server: my-server
- ip_address: 123.123.123.123
- dns_ptr: example.com
- state: present
-
-- name: Ensure the reverse DNS entry is absent (remove if needed)
- hcloud_rdns:
- server: my-server
- ip_address: 123.123.123.123
- dns_ptr: example.com
- state: absent
-"""
-
-RETURN = """
-hcloud_rdns:
- description: The reverse DNS entry
- returned: always
- type: complex
- contains:
- server:
- description: Name of the server
- type: str
- returned: always
- sample: my-server
- ip_address:
- description: The IP address that point to the DNS ptr
- type: str
- returned: always
- sample: 123.123.123.123
- dns_ptr:
- description: The DNS that resolves to the IP
- type: str
- returned: always
- sample: example.com
-"""
-
-from ansible.module_utils.basic import AnsibleModule
-from ansible.module_utils._text import to_native
-from ansible.module_utils.hcloud import Hcloud
-from ansible.module_utils.network.common import utils
-
-try:
- from hcloud import APIException
-except ImportError:
- APIException = None
-
-
-class AnsibleHcloudReverseDNS(Hcloud):
- def __init__(self, module):
- super(AnsibleHcloudReverseDNS, self).__init__(module, "hcloud_rdns")
- self.hcloud_server = None
- self.hcloud_rdns = None
-
- def _prepare_result(self):
- return {
- "server": to_native(self.hcloud_server.name),
- "ip_address": to_native(self.hcloud_rdns["ip_address"]),
- "dns_ptr": to_native(self.hcloud_rdns["dns_ptr"]),
- }
-
- def _get_server(self):
- try:
- self.hcloud_server = self.client.servers.get_by_name(
- self.module.params.get("server")
- )
- except APIException as e:
- self.module.fail_json(msg=e.message)
-
- def _get_rdns(self):
- ip_address = self.module.params.get("ip_address")
- if utils.validate_ip_address(ip_address):
- if self.hcloud_server.public_net.ipv4.ip == ip_address:
- self.hcloud_rdns = {
- "ip_address": self.hcloud_server.public_net.ipv4.ip,
- "dns_ptr": self.hcloud_server.public_net.ipv4.dns_ptr,
- }
- else:
- self.module.fail_json(msg="The selected server does not have this IP address")
- elif utils.validate_ip_v6_address(ip_address):
- for ipv6_address_dns_ptr in self.hcloud_server.public_net.ipv6.dns_ptr:
- if ipv6_address_dns_ptr["ip"] == ip_address:
- self.hcloud_rdns = {
- "ip_address": ipv6_address_dns_ptr["ip"],
- "dns_ptr": ipv6_address_dns_ptr["dns_ptr"],
- }
- else:
- self.module.fail_json(msg="The given IP address is not valid")
-
- def _create_rdns(self):
- self.module.fail_on_missing_params(
- required_params=["dns_ptr"]
- )
- params = {
- "ip": self.module.params.get("ip_address"),
- "dns_ptr": self.module.params.get("dns_ptr"),
- }
-
- if not self.module.check_mode:
- self.hcloud_server.change_dns_ptr(**params).wait_until_finished()
-
- self._mark_as_changed()
- self._get_server()
- self._get_rdns()
-
- def _update_rdns(self):
- dns_ptr = self.module.params.get("dns_ptr")
- if dns_ptr != self.hcloud_rdns["dns_ptr"]:
- params = {
- "ip": self.module.params.get("ip_address"),
- "dns_ptr": dns_ptr,
- }
-
- if not self.module.check_mode:
- self.hcloud_server.change_dns_ptr(**params).wait_until_finished()
-
- self._mark_as_changed()
- self._get_server()
- self._get_rdns()
-
- def present_rdns(self):
- self._get_server()
- self._get_rdns()
- if self.hcloud_rdns is None:
- self._create_rdns()
- else:
- self._update_rdns()
-
- def delete_rdns(self):
- self._get_server()
- self._get_rdns()
- if self.hcloud_rdns is not None:
- if not self.module.check_mode:
- self.hcloud_server.change_dns_ptr(ip=self.hcloud_rdns['ip_address'], dns_ptr=None)
- self._mark_as_changed()
- self.hcloud_rdns = None
-
- @staticmethod
- def define_module():
- return AnsibleModule(
- argument_spec=dict(
- server={"type": "str", "required": True},
- ip_address={"type": "str", "required": True},
- dns_ptr={"type": "str"},
- state={
- "choices": ["absent", "present"],
- "default": "present",
- },
- **Hcloud.base_module_arguments()
- ),
- supports_check_mode=True,
- )
-
-
-def main():
- module = AnsibleHcloudReverseDNS.define_module()
-
- hcloud = AnsibleHcloudReverseDNS(module)
- state = module.params["state"]
- if state == "absent":
- hcloud.delete_rdns()
- elif state == "present":
- hcloud.present_rdns()
-
- module.exit_json(**hcloud.get_result())
-
-
-if __name__ == "__main__":
- main()