mirror of
https://github.com/freeipa/ansible-freeipa.git
synced 2026-07-31 03:44:41 +00:00
ipahostgroup: 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 - `type: list` needs to be set for list parameters - `elements: str` needs to be given for list of string parameters - `required` tags need to be fixed according to the `argument_spec` argument_spec - `elements="str"` needs to be added to all list of string parameters The `copyright` date is extended with `-2022`.
This commit is contained in:
@@ -3,7 +3,7 @@
|
|||||||
# Authors:
|
# Authors:
|
||||||
# Thomas Woerner <twoerner@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
|
# 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
|
||||||
@@ -40,10 +40,13 @@ extends_documentation_fragment:
|
|||||||
options:
|
options:
|
||||||
name:
|
name:
|
||||||
description: The hostgroup name
|
description: The hostgroup name
|
||||||
required: false
|
type: list
|
||||||
|
elements: str
|
||||||
|
required: true
|
||||||
aliases: ["cn"]
|
aliases: ["cn"]
|
||||||
description:
|
description:
|
||||||
description: The hostgroup description
|
description: The hostgroup description
|
||||||
|
type: str
|
||||||
required: false
|
required: false
|
||||||
nomembers:
|
nomembers:
|
||||||
description: Suppress processing of membership attributes
|
description: Suppress processing of membership attributes
|
||||||
@@ -53,38 +56,45 @@ options:
|
|||||||
description: List of host names assigned to this hostgroup.
|
description: List of host names assigned to this hostgroup.
|
||||||
required: false
|
required: false
|
||||||
type: list
|
type: list
|
||||||
|
elements: str
|
||||||
hostgroup:
|
hostgroup:
|
||||||
description: List of hostgroup names assigned to this hostgroup.
|
description: List of hostgroup names assigned to this hostgroup.
|
||||||
required: false
|
required: false
|
||||||
type: list
|
type: list
|
||||||
|
elements: str
|
||||||
membermanager_user:
|
membermanager_user:
|
||||||
description:
|
description:
|
||||||
- List of member manager users assigned to this hostgroup.
|
- List of member manager users assigned to this hostgroup.
|
||||||
- Only usable with IPA versions 4.8.4 and up.
|
- Only usable with IPA versions 4.8.4 and up.
|
||||||
required: false
|
required: false
|
||||||
type: list
|
type: list
|
||||||
|
elements: str
|
||||||
membermanager_group:
|
membermanager_group:
|
||||||
description:
|
description:
|
||||||
- List of member manager groups assigned to this hostgroup.
|
- List of member manager groups assigned to this hostgroup.
|
||||||
- Only usable with IPA versions 4.8.4 and up.
|
- Only usable with IPA versions 4.8.4 and up.
|
||||||
required: false
|
required: false
|
||||||
type: list
|
type: list
|
||||||
|
elements: str
|
||||||
rename:
|
rename:
|
||||||
description:
|
description:
|
||||||
- Rename hostgroup to the given name.
|
- Rename hostgroup to the given name.
|
||||||
- Only usable with IPA versions 4.8.7 and up.
|
- Only usable with IPA versions 4.8.7 and up.
|
||||||
|
type: str
|
||||||
required: false
|
required: false
|
||||||
aliases: ["new_name"]
|
aliases: ["new_name"]
|
||||||
action:
|
action:
|
||||||
description: Work on hostgroup or member level
|
description: Work on hostgroup or member level
|
||||||
|
type: str
|
||||||
default: hostgroup
|
default: hostgroup
|
||||||
choices: ["member", "hostgroup"]
|
choices: ["member", "hostgroup"]
|
||||||
state:
|
state:
|
||||||
description: State to ensure
|
description: State to ensure
|
||||||
|
type: str
|
||||||
default: present
|
default: present
|
||||||
choices: ["present", "absent", "renamed"]
|
choices: ["present", "absent", "renamed"]
|
||||||
author:
|
author:
|
||||||
- Thomas Woerner
|
- Thomas Woerner (@t-woerner)
|
||||||
"""
|
"""
|
||||||
|
|
||||||
EXAMPLES = """
|
EXAMPLES = """
|
||||||
@@ -185,16 +195,19 @@ def main():
|
|||||||
ansible_module = IPAAnsibleModule(
|
ansible_module = IPAAnsibleModule(
|
||||||
argument_spec=dict(
|
argument_spec=dict(
|
||||||
# general
|
# general
|
||||||
name=dict(type="list", aliases=["cn"], default=None,
|
name=dict(type="list", elements="str", aliases=["cn"],
|
||||||
required=True),
|
required=True),
|
||||||
# present
|
# present
|
||||||
description=dict(type="str", default=None),
|
description=dict(type="str", default=None),
|
||||||
nomembers=dict(required=False, type='bool', default=None),
|
nomembers=dict(required=False, type='bool', default=None),
|
||||||
host=dict(required=False, type='list', default=None),
|
host=dict(required=False, type='list', elements="str",
|
||||||
hostgroup=dict(required=False, type='list', default=None),
|
default=None),
|
||||||
membermanager_user=dict(required=False, type='list', default=None),
|
hostgroup=dict(required=False, type='list', elements="str",
|
||||||
|
default=None),
|
||||||
|
membermanager_user=dict(required=False, type='list',
|
||||||
|
elements="str", default=None),
|
||||||
membermanager_group=dict(required=False, type='list',
|
membermanager_group=dict(required=False, type='list',
|
||||||
default=None),
|
elements="str", default=None),
|
||||||
rename=dict(required=False, type='str', default=None,
|
rename=dict(required=False, type='str', default=None,
|
||||||
aliases=["new_name"]),
|
aliases=["new_name"]),
|
||||||
action=dict(type="str", default="hostgroup",
|
action=dict(type="str", default="hostgroup",
|
||||||
|
|||||||
Reference in New Issue
Block a user