Skip to content
Snippets Groups Projects
Commit 9c71d91a authored by Thomas Woerner's avatar Thomas Woerner
Browse files

ipatopologysegment: 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
- `author` needs to be given with the github user also: `Name (@user)`

argument_spec

- `type="str"` needs to added to all string parameters

The `copyright` date is extended with `-2022`.
parent 07c8bb1e
No related branches found
No related tags found
No related merge requests found
...@@ -3,7 +3,7 @@ ...@@ -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
...@@ -39,29 +39,37 @@ extends_documentation_fragment: ...@@ -39,29 +39,37 @@ extends_documentation_fragment:
options: options:
suffix: suffix:
description: Topology suffix description: Topology suffix
type: str
required: true required: true
choices: ["domain", "ca", "domain+ca"] choices: ["domain", "ca", "domain+ca"]
name: name:
description: Topology segment name, unique identifier. description: Topology segment name, unique identifier.
type: str
required: false required: false
aliases: ["cn"] aliases: ["cn"]
left: left:
description: Left replication node - an IPA server description: Left replication node - an IPA server
type: str
required: false
aliases: ["leftnode"] aliases: ["leftnode"]
right: right:
description: Right replication node - an IPA server description: Right replication node - an IPA server
type: str
required: false
aliases: ["rightnode"] aliases: ["rightnode"]
direction: direction:
description: The direction a segment will be reinitialized description: The direction a segment will be reinitialized
type: str
required: false required: false
choices: ["left-to-right", "right-to-left"] choices: ["left-to-right", "right-to-left"]
state: state:
description: State to ensure description: State to ensure
type: str
default: present default: present
choices: ["present", "absent", "enabled", "disabled", "reinitialized", choices: ["present", "absent", "enabled", "disabled", "reinitialized",
"checked" ] "checked" ]
author: author:
- Thomas Woerner - Thomas Woerner (@t-woerner)
""" """
EXAMPLES = """ EXAMPLES = """
...@@ -178,7 +186,8 @@ def find_left_right_cn(module, suffix, left, right, name): ...@@ -178,7 +186,8 @@ def find_left_right_cn(module, suffix, left, right, name):
def main(): def main():
ansible_module = IPAAnsibleModule( ansible_module = IPAAnsibleModule(
argument_spec=dict( argument_spec=dict(
suffix=dict(choices=["domain", "ca", "domain+ca"], required=True), suffix=dict(type="str", choices=["domain", "ca", "domain+ca"],
required=True),
name=dict(type="str", aliases=["cn"], default=None), name=dict(type="str", aliases=["cn"], default=None),
left=dict(type="str", aliases=["leftnode"], default=None), left=dict(type="str", aliases=["leftnode"], default=None),
right=dict(type="str", aliases=["rightnode"], default=None), right=dict(type="str", aliases=["rightnode"], default=None),
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment