mirror of
https://github.com/freeipa/ansible-freeipa.git
synced 2026-07-29 02:44:43 +00:00
Merge pull request #946 from t-woerner/fix_selfservice_docs_for_ansible_test
ipaselfservice: Fix documentation sections and agument spec
This commit is contained in:
@@ -3,7 +3,7 @@
|
|||||||
# Authors:
|
# Authors:
|
||||||
# Thomas Woerner <twoerner@redhat.com>
|
# Thomas Woerner <twoerner@redhat.com>
|
||||||
#
|
#
|
||||||
# Copyright (C) 2020 Red Hat
|
# Copyright (C) 2020-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,26 +39,36 @@ extends_documentation_fragment:
|
|||||||
options:
|
options:
|
||||||
name:
|
name:
|
||||||
description: The list of selfservice name strings.
|
description: The list of selfservice name strings.
|
||||||
|
type: list
|
||||||
|
elements: str
|
||||||
required: true
|
required: true
|
||||||
aliases: ["aciname"]
|
aliases: ["aciname"]
|
||||||
permission:
|
permission:
|
||||||
description: Permissions to grant (read, write). Default is write.
|
description: Permissions to grant (read, write). Default is write.
|
||||||
|
type: list
|
||||||
|
elements: str
|
||||||
required: false
|
required: false
|
||||||
aliases: ["permissions"]
|
aliases: ["permissions"]
|
||||||
attribute:
|
attribute:
|
||||||
description: Attribute list to which the selfservice applies
|
description: Attribute list to which the selfservice applies
|
||||||
|
type: list
|
||||||
|
elements: str
|
||||||
required: false
|
required: false
|
||||||
aliases: ["attrs"]
|
aliases: ["attrs"]
|
||||||
action:
|
action:
|
||||||
description: Work on selfservice or member level.
|
description: Work on selfservice or member level.
|
||||||
|
type: str
|
||||||
choices: ["selfservice", "member"]
|
choices: ["selfservice", "member"]
|
||||||
default: selfservice
|
default: selfservice
|
||||||
required: false
|
required: false
|
||||||
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 = """
|
||||||
@@ -130,13 +140,13 @@ def main():
|
|||||||
ansible_module = IPAAnsibleModule(
|
ansible_module = IPAAnsibleModule(
|
||||||
argument_spec=dict(
|
argument_spec=dict(
|
||||||
# general
|
# general
|
||||||
name=dict(type="list", aliases=["aciname"], default=None,
|
name=dict(type="list", elements="str", aliases=["aciname"],
|
||||||
required=True),
|
required=True),
|
||||||
# present
|
# present
|
||||||
permission=dict(required=False, type='list',
|
permission=dict(required=False, type='list', elements="str",
|
||||||
aliases=["permissions"], default=None),
|
aliases=["permissions"], default=None),
|
||||||
attribute=dict(required=False, type='list', aliases=["attrs"],
|
attribute=dict(required=False, type='list', elements="str",
|
||||||
default=None),
|
aliases=["attrs"], default=None),
|
||||||
action=dict(type="str", default="selfservice",
|
action=dict(type="str", default="selfservice",
|
||||||
choices=["member", "selfservice"]),
|
choices=["member", "selfservice"]),
|
||||||
# state
|
# state
|
||||||
|
|||||||
Reference in New Issue
Block a user