From 0fa28ba1fa37eb885b81f6c49e24a4a1baaae2bc Mon Sep 17 00:00:00 2001
From: Thomas Woerner <twoerner@redhat.com>
Date: Fri, 30 Sep 2022 14:33:40 +0200
Subject: [PATCH] ipadnsforwardzone: : Fix documentation sections and agument
spec
ansible-test with ansible-2.14 is adding a lot of new tests to ensure
that the documentation section and the agument spec is complete. Needed
changes:
DOCUMENTATION section
- `module` tag needs to be correct
- `type: str` needs to be set for string parameters
- `type: list` needs to be set for list parameters
- `elements: str` needs to be given for list of string parameters
- `suboptions` instead of `options` needs to be used for dict parameters
- `aliases` tag needs to match `argument_spec`
- `default` tag needs to match `argument_spec`
- `authors` needs to be given with the github user also: `Name (@user)`
- `action` parameter is missing and added
argument_spec
- `elements="str"` needs to be added to all list of string parameters
The `copyright` date is extended with `-2022`.
---
plugins/modules/ipadnsforwardzone.py | 38 ++++++++++++++++++++--------
1 file changed, 27 insertions(+), 11 deletions(-)
diff --git a/plugins/modules/ipadnsforwardzone.py b/plugins/modules/ipadnsforwardzone.py
index f4c6c634..87ed9826 100644
--- a/plugins/modules/ipadnsforwardzone.py
+++ b/plugins/modules/ipadnsforwardzone.py
@@ -2,8 +2,9 @@
# Authors:
# Chris Procter <cprocter@redhat.com>
+# Thomas Woerner <twoerner@redhat.com>
#
-# Copyright (C) 2019 Red Hat
+# Copyright (C) 2019-2022 Red Hat
# see file 'COPYING' for use and warranty information
#
# This program is free software; you can redistribute it and/or modify
@@ -32,53 +33,68 @@ ANSIBLE_METADATA = {
DOCUMENTATION = '''
---
-module: ipa_dnsforwardzone
-author: chris procter
+module: ipadnsforwardzone
+author:
+ - Chris Procter (@chr15p)
+ - Thomas Woerner (@t-woerner)
short_description: Manage FreeIPA DNS Forwarder Zones
description:
-- Add and delete an IPA DNS Forwarder Zones using IPA API
+ - Add and delete an IPA DNS Forwarder Zones using IPA API
extends_documentation_fragment:
- ipamodule_base_docs
options:
name:
description:
- The DNS zone name which needs to be managed.
+ type: list
+ elements: str
required: true
aliases: ["cn"]
+ action:
+ description: |
+ Work on dnsforwardzone or member level. It can be one of `member` or
+ `dnsforwardzone`.
+ type: str
+ default: "dnsforwardzone"
+ choices: ["member", "dnsforwardzone"]
state:
description: State to ensure
+ type: str
required: false
default: present
choices: ["present", "absent", "enabled", "disabled"]
forwarders:
description:
- List of the DNS servers to forward to
+ type: list
+ elements: dict
aliases: ["idnsforwarders"]
- options:
+ suboptions:
ip_address:
description: Forwarder IP address (either IPv4 or IPv6).
- required: false
- type: string
+ required: true
+ type: str
port:
description: Forwarder port.
required: false
type: int
forwardpolicy:
description: Per-zone conditional forwarding policy
+ type: str
required: false
- default: only
choices: ["only", "first", "none"]
- aliases: ["idnsforwarders", "forward_policy"]
+ aliases: ["idnsforwardpolicy", "forward_policy"]
skip_overlap_check:
description:
- Force DNS zone creation even if it will overlap with an existing zone.
+ type: bool
required: false
- default: false
permission:
description:
- Allow DNS Forward Zone to be managed.
required: false
type: bool
+ aliases: ["managedby"]
'''
EXAMPLES = '''
@@ -180,7 +196,7 @@ def main():
ansible_module = IPAAnsibleModule(
argument_spec=dict(
# general
- name=dict(type="list", aliases=["cn"], default=None,
+ name=dict(type="list", elements="str", aliases=["cn"],
required=True),
forwarders=dict(type="list", default=None, required=False,
aliases=["idnsforwarders"], elements='dict',
--
GitLab