Merge pull request #947 from t-woerner/fix_server_docs_for_ansible_test

ipaserver: Fix documentation sections and agument spec
This commit is contained in:
Rafael Guterres Jeffman
2022-10-08 17:17:44 -03:00
committed by GitHub

View File

@@ -3,7 +3,7 @@
# Authors: # Authors:
# Thomas Woerner <twoerner@redhat.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
@@ -39,6 +39,8 @@ extends_documentation_fragment:
options: options:
name: name:
description: The list of server name strings. description: The list of server name strings.
type: list
elements: str
required: true required: true
aliases: ["cn"] aliases: ["cn"]
location: location:
@@ -46,6 +48,7 @@ options:
The server location string. The server location string.
"" for location reset. "" for location reset.
Only in state: present. Only in state: present.
type: str
required: false required: false
aliases: ["ipalocation_location"] aliases: ["ipalocation_location"]
service_weight: service_weight:
@@ -96,9 +99,12 @@ options:
type: bool type: bool
state: state:
description: The state to ensure. description: The state to ensure.
type: str
choices: ["present", "absent"] choices: ["present", "absent"]
default: present default: present
required: true required: false
author:
- Thomas Woerner (@t-woerner)
""" """
EXAMPLES = """ EXAMPLES = """
@@ -244,8 +250,8 @@ def main():
ansible_module = IPAAnsibleModule( ansible_module = IPAAnsibleModule(
argument_spec=dict( argument_spec=dict(
# general # general
name=dict(type="list", aliases=["cn"], name=dict(type="list", elements="str", aliases=["cn"],
default=None, required=True), required=True),
# present # present
location=dict(required=False, type='str', location=dict(required=False, type='str',
aliases=["ipalocation_location"], default=None), aliases=["ipalocation_location"], default=None),