mirror of
https://github.com/freeipa/ansible-freeipa.git
synced 2026-08-02 04:44:42 +00:00
ipaautomember: 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 - `type: str` needs to be set for string parameters - `elements: str` needs to be given for list of string parameters - `suboptions` instead of `options` needs to be used for dict parameters - `authors` needs to be given with the github user also: `Name (@user)` - `required` tag was fixed according to the argument_spec arguemnt_spec - `elements="str"` needs to be added to all list of string parameters - `no_log=False` or `no_log=True` needs to be set for all parameters that have `key` in the name or for dicts also in one the key names. The `copyright` date is extended with `-2022`.
This commit is contained in:
@@ -3,8 +3,9 @@
|
|||||||
# Authors:
|
# Authors:
|
||||||
# Mark Hahl <mhahl@redhat.com>
|
# Mark Hahl <mhahl@redhat.com>
|
||||||
# Jake Reynolds <jakealexis@gmail.com>
|
# Jake Reynolds <jakealexis@gmail.com>
|
||||||
|
# Thomas Woerner <twoerner@redhat.com>
|
||||||
#
|
#
|
||||||
# Copyright (C) 2021 Red Hat
|
# Copyright (C) 2021-2022 Red Hat
|
||||||
# see file 'COPYING' for use and warranty information
|
# see file 'COPYING' for use and warranty information
|
||||||
#
|
#
|
||||||
# This program is free software; you can redistribute it and/or modify
|
# This program is free software; you can redistribute it and/or modify
|
||||||
@@ -41,14 +42,17 @@ extends_documentation_fragment:
|
|||||||
options:
|
options:
|
||||||
name:
|
name:
|
||||||
description: The automember rule
|
description: The automember rule
|
||||||
required: true
|
required: false
|
||||||
|
type: list
|
||||||
|
elements: str
|
||||||
aliases: ["cn"]
|
aliases: ["cn"]
|
||||||
description:
|
description:
|
||||||
description: A description of this auto member rule
|
description: A description of this auto member rule
|
||||||
required: false
|
required: false
|
||||||
|
type: str
|
||||||
automember_type:
|
automember_type:
|
||||||
description: Grouping to which the rule applies
|
description: Grouping to which the rule applies
|
||||||
required: true
|
required: false
|
||||||
type: str
|
type: str
|
||||||
choices: ["group", "hostgroup"]
|
choices: ["group", "hostgroup"]
|
||||||
exclusive:
|
exclusive:
|
||||||
@@ -56,7 +60,7 @@ options:
|
|||||||
type: list
|
type: list
|
||||||
elements: dict
|
elements: dict
|
||||||
aliases: ["automemberexclusiveregex"]
|
aliases: ["automemberexclusiveregex"]
|
||||||
options:
|
suboptions:
|
||||||
key:
|
key:
|
||||||
description: The attribute of the regex
|
description: The attribute of the regex
|
||||||
type: str
|
type: str
|
||||||
@@ -70,7 +74,7 @@ options:
|
|||||||
type: list
|
type: list
|
||||||
elements: dict
|
elements: dict
|
||||||
aliases: ["automemberinclusiveregex"]
|
aliases: ["automemberinclusiveregex"]
|
||||||
options:
|
suboptions:
|
||||||
key:
|
key:
|
||||||
description: The attribute of the regex
|
description: The attribute of the regex
|
||||||
type: str
|
type: str
|
||||||
@@ -82,10 +86,12 @@ options:
|
|||||||
users:
|
users:
|
||||||
description: Users to rebuild membership for.
|
description: Users to rebuild membership for.
|
||||||
type: list
|
type: list
|
||||||
|
elements: str
|
||||||
required: false
|
required: false
|
||||||
hosts:
|
hosts:
|
||||||
description: Hosts to rebuild membership for.
|
description: Hosts to rebuild membership for.
|
||||||
type: list
|
type: list
|
||||||
|
elements: str
|
||||||
required: false
|
required: false
|
||||||
no_wait:
|
no_wait:
|
||||||
description: Don't wait for rebuilding membership.
|
description: Don't wait for rebuilding membership.
|
||||||
@@ -95,16 +101,18 @@ options:
|
|||||||
type: str
|
type: str
|
||||||
action:
|
action:
|
||||||
description: Work on automember or member level
|
description: Work on automember or member level
|
||||||
|
type: str
|
||||||
default: automember
|
default: automember
|
||||||
choices: ["member", "automember"]
|
choices: ["member", "automember"]
|
||||||
state:
|
state:
|
||||||
description: State to ensure
|
description: State to ensure
|
||||||
|
type: str
|
||||||
default: present
|
default: present
|
||||||
choices: ["present", "absent", "rebuilt", "orphans_removed"]
|
choices: ["present", "absent", "rebuilt", "orphans_removed"]
|
||||||
author:
|
author:
|
||||||
- Mark Hahl
|
- Mark Hahl (@mhahl)
|
||||||
- Jake Reynolds
|
- Jake Reynolds (@jake2184)
|
||||||
- Thomas Woerner
|
- Thomas Woerner (@t-woerner)
|
||||||
"""
|
"""
|
||||||
|
|
||||||
EXAMPLES = """
|
EXAMPLES = """
|
||||||
@@ -208,7 +216,6 @@ EXAMPLES = """
|
|||||||
RETURN = """
|
RETURN = """
|
||||||
"""
|
"""
|
||||||
|
|
||||||
|
|
||||||
from ansible.module_utils.ansible_freeipa_module import (
|
from ansible.module_utils.ansible_freeipa_module import (
|
||||||
IPAAnsibleModule, compare_args_ipa, gen_add_del_lists, ipalib_errors, DN
|
IPAAnsibleModule, compare_args_ipa, gen_add_del_lists, ipalib_errors, DN
|
||||||
)
|
)
|
||||||
@@ -315,7 +322,8 @@ def main():
|
|||||||
aliases=["automemberinclusiveregex"],
|
aliases=["automemberinclusiveregex"],
|
||||||
default=None,
|
default=None,
|
||||||
options=dict(
|
options=dict(
|
||||||
key=dict(type="str", required=True),
|
key=dict(type="str", required=True,
|
||||||
|
no_log=False),
|
||||||
expression=dict(type="str", required=True)
|
expression=dict(type="str", required=True)
|
||||||
),
|
),
|
||||||
elements="dict",
|
elements="dict",
|
||||||
@@ -324,12 +332,13 @@ def main():
|
|||||||
aliases=["automemberexclusiveregex"],
|
aliases=["automemberexclusiveregex"],
|
||||||
default=None,
|
default=None,
|
||||||
options=dict(
|
options=dict(
|
||||||
key=dict(type="str", required=True),
|
key=dict(type="str", required=True,
|
||||||
|
no_log=False),
|
||||||
expression=dict(type="str", required=True)
|
expression=dict(type="str", required=True)
|
||||||
),
|
),
|
||||||
elements="dict",
|
elements="dict",
|
||||||
required=False),
|
required=False),
|
||||||
name=dict(type="list", aliases=["cn"],
|
name=dict(type="list", elements="str", aliases=["cn"],
|
||||||
default=None, required=False),
|
default=None, required=False),
|
||||||
description=dict(type="str", default=None),
|
description=dict(type="str", default=None),
|
||||||
automember_type=dict(type='str', required=False,
|
automember_type=dict(type='str', required=False,
|
||||||
@@ -341,8 +350,8 @@ def main():
|
|||||||
state=dict(type="str", default="present",
|
state=dict(type="str", default="present",
|
||||||
choices=["present", "absent", "rebuilt",
|
choices=["present", "absent", "rebuilt",
|
||||||
"orphans_removed"]),
|
"orphans_removed"]),
|
||||||
users=dict(type="list", default=None),
|
users=dict(type="list", elements="str", default=None),
|
||||||
hosts=dict(type="list", default=None),
|
hosts=dict(type="list", elements="str", default=None),
|
||||||
),
|
),
|
||||||
supports_check_mode=True,
|
supports_check_mode=True,
|
||||||
)
|
)
|
||||||
|
|||||||
Reference in New Issue
Block a user