mirror of
https://github.com/freeipa/ansible-freeipa.git
synced 2026-07-30 03:14:42 +00:00
ipasudorule: 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 - `aliases` tag needs to match `argument_spec` - `author` needs to be given with the github user also: `Name (@user)` 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:
@@ -2,8 +2,9 @@
|
|||||||
|
|
||||||
# Authors:
|
# Authors:
|
||||||
# Rafael Guterres Jeffman <rjeffman@redhat.com>
|
# Rafael Guterres Jeffman <rjeffman@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 +40,39 @@ extends_documentation_fragment:
|
|||||||
options:
|
options:
|
||||||
name:
|
name:
|
||||||
description: The sudorule name
|
description: The sudorule name
|
||||||
|
type: list
|
||||||
|
elements: str
|
||||||
required: true
|
required: true
|
||||||
aliases: ["cn"]
|
aliases: ["cn"]
|
||||||
description:
|
description:
|
||||||
description: The sudorule description
|
description: The sudorule description
|
||||||
|
type: str
|
||||||
required: false
|
required: false
|
||||||
user:
|
user:
|
||||||
description: List of users assigned to the sudo rule.
|
description: List of users assigned to the sudo rule.
|
||||||
|
type: list
|
||||||
|
elements: str
|
||||||
required: false
|
required: false
|
||||||
usercategory:
|
usercategory:
|
||||||
description: User category the sudo rule applies to
|
description: User category the sudo rule applies to
|
||||||
|
type: str
|
||||||
required: false
|
required: false
|
||||||
choices: ["all", ""]
|
choices: ["all", ""]
|
||||||
aliases: ["usercat"]
|
aliases: ["usercat"]
|
||||||
group:
|
group:
|
||||||
description: List of user groups assigned to the sudo rule.
|
description: List of user groups assigned to the sudo rule.
|
||||||
|
type: list
|
||||||
|
elements: str
|
||||||
required: false
|
required: false
|
||||||
runasgroupcategory:
|
runasgroupcategory:
|
||||||
description: RunAs Group category applied to the sudo rule.
|
description: RunAs Group category applied to the sudo rule.
|
||||||
|
type: str
|
||||||
required: false
|
required: false
|
||||||
choices: ["all", ""]
|
choices: ["all", ""]
|
||||||
aliases: ["runasgroupcat"]
|
aliases: ["runasgroupcat"]
|
||||||
runasusercategory:
|
runasusercategory:
|
||||||
description: RunAs User category applied to the sudorule.
|
description: RunAs User category applied to the sudorule.
|
||||||
|
type: str
|
||||||
required: false
|
required: false
|
||||||
choices: ["all", ""]
|
choices: ["all", ""]
|
||||||
aliases: ["runasusercat"]
|
aliases: ["runasusercat"]
|
||||||
@@ -73,12 +84,15 @@ options:
|
|||||||
description: List of host names assigned to this sudorule.
|
description: List of host names assigned to this sudorule.
|
||||||
required: false
|
required: false
|
||||||
type: list
|
type: list
|
||||||
|
elements: str
|
||||||
hostgroup:
|
hostgroup:
|
||||||
description: List of host groups assigned to this sudorule.
|
description: List of host groups assigned to this sudorule.
|
||||||
required: false
|
required: false
|
||||||
type: list
|
type: list
|
||||||
|
elements: str
|
||||||
hostcategory:
|
hostcategory:
|
||||||
description: Host category the sudo rule applies to.
|
description: Host category the sudo rule applies to.
|
||||||
|
type: str
|
||||||
required: false
|
required: false
|
||||||
choices: ["all", ""]
|
choices: ["all", ""]
|
||||||
aliases: ["hostcat"]
|
aliases: ["hostcat"]
|
||||||
@@ -86,20 +100,25 @@ options:
|
|||||||
description: List of allowed sudocmds assigned to this sudorule.
|
description: List of allowed sudocmds assigned to this sudorule.
|
||||||
required: false
|
required: false
|
||||||
type: list
|
type: list
|
||||||
|
elements: str
|
||||||
allow_sudocmdgroup:
|
allow_sudocmdgroup:
|
||||||
description: List of allowed sudocmd groups assigned to this sudorule.
|
description: List of allowed sudocmd groups assigned to this sudorule.
|
||||||
required: false
|
required: false
|
||||||
type: list
|
type: list
|
||||||
|
elements: str
|
||||||
deny_sudocmd:
|
deny_sudocmd:
|
||||||
description: List of denied sudocmds assigned to this sudorule.
|
description: List of denied sudocmds assigned to this sudorule.
|
||||||
required: false
|
required: false
|
||||||
type: list
|
type: list
|
||||||
|
elements: str
|
||||||
deny_sudocmdgroup:
|
deny_sudocmdgroup:
|
||||||
description: List of denied sudocmd groups assigned to this sudorule.
|
description: List of denied sudocmd groups assigned to this sudorule.
|
||||||
required: false
|
required: false
|
||||||
type: list
|
type: list
|
||||||
|
elements: str
|
||||||
cmdcategory:
|
cmdcategory:
|
||||||
description: Command category the sudo rule applies to
|
description: Command category the sudo rule applies to
|
||||||
|
type: str
|
||||||
required: false
|
required: false
|
||||||
choices: ["all", ""]
|
choices: ["all", ""]
|
||||||
aliases: ["cmdcat"]
|
aliases: ["cmdcat"]
|
||||||
@@ -107,29 +126,36 @@ options:
|
|||||||
description: Order to apply this rule.
|
description: Order to apply this rule.
|
||||||
required: false
|
required: false
|
||||||
type: int
|
type: int
|
||||||
|
aliases: ["sudoorder"]
|
||||||
sudooption:
|
sudooption:
|
||||||
description: List of sudo options.
|
description: List of sudo options.
|
||||||
required: false
|
required: false
|
||||||
type: list
|
type: list
|
||||||
|
elements: str
|
||||||
aliases: ["options"]
|
aliases: ["options"]
|
||||||
runasuser:
|
runasuser:
|
||||||
description: List of users for Sudo to execute as.
|
description: List of users for Sudo to execute as.
|
||||||
required: false
|
required: false
|
||||||
type: list
|
type: list
|
||||||
|
elements: str
|
||||||
runasgroup:
|
runasgroup:
|
||||||
description: List of groups for Sudo to execute as.
|
description: List of groups for Sudo to execute as.
|
||||||
required: false
|
required: false
|
||||||
type: list
|
type: list
|
||||||
|
elements: str
|
||||||
action:
|
action:
|
||||||
description: Work on sudorule or member level
|
description: Work on sudorule or member level
|
||||||
|
type: str
|
||||||
default: sudorule
|
default: sudorule
|
||||||
choices: ["member", "sudorule"]
|
choices: ["member", "sudorule"]
|
||||||
state:
|
state:
|
||||||
description: State to ensure
|
description: State to ensure
|
||||||
|
type: str
|
||||||
default: present
|
default: present
|
||||||
choices: ["present", "absent", "enabled", "disabled"]
|
choices: ["present", "absent", "enabled", "disabled"]
|
||||||
author:
|
author:
|
||||||
- Rafael Jeffman
|
- Rafael Guterres Jeffman (@rjeffman)
|
||||||
|
- Thomas Woerner (@t-woerner)
|
||||||
"""
|
"""
|
||||||
|
|
||||||
EXAMPLES = """
|
EXAMPLES = """
|
||||||
@@ -236,7 +262,7 @@ 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(required=False, type="str", default=None),
|
description=dict(required=False, type="str", default=None),
|
||||||
@@ -245,14 +271,22 @@ def main():
|
|||||||
hostcategory=dict(required=False, type="str", default=None,
|
hostcategory=dict(required=False, type="str", default=None,
|
||||||
choices=["all", ""], aliases=['hostcat']),
|
choices=["all", ""], aliases=['hostcat']),
|
||||||
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),
|
||||||
user=dict(required=False, type='list', default=None),
|
hostgroup=dict(required=False, type='list', elements="str",
|
||||||
group=dict(required=False, type='list', default=None),
|
default=None),
|
||||||
allow_sudocmd=dict(required=False, type="list", default=None),
|
user=dict(required=False, type='list', elements="str",
|
||||||
deny_sudocmd=dict(required=False, type="list", default=None),
|
default=None),
|
||||||
allow_sudocmdgroup=dict(required=False, type="list", default=None),
|
group=dict(required=False, type='list', elements="str",
|
||||||
deny_sudocmdgroup=dict(required=False, type="list", default=None),
|
default=None),
|
||||||
|
allow_sudocmd=dict(required=False, type="list", elements="str",
|
||||||
|
default=None),
|
||||||
|
deny_sudocmd=dict(required=False, type="list", elements="str",
|
||||||
|
default=None),
|
||||||
|
allow_sudocmdgroup=dict(required=False, type="list",
|
||||||
|
elements="str", default=None),
|
||||||
|
deny_sudocmdgroup=dict(required=False, type="list", elements="str",
|
||||||
|
default=None),
|
||||||
cmdcategory=dict(required=False, type="str", default=None,
|
cmdcategory=dict(required=False, type="str", default=None,
|
||||||
choices=["all", ""], aliases=['cmdcat']),
|
choices=["all", ""], aliases=['cmdcat']),
|
||||||
runasusercategory=dict(required=False, type="str", default=None,
|
runasusercategory=dict(required=False, type="str", default=None,
|
||||||
@@ -261,11 +295,13 @@ def main():
|
|||||||
runasgroupcategory=dict(required=False, type="str", default=None,
|
runasgroupcategory=dict(required=False, type="str", default=None,
|
||||||
choices=["all", ""],
|
choices=["all", ""],
|
||||||
aliases=['runasgroupcat']),
|
aliases=['runasgroupcat']),
|
||||||
runasuser=dict(required=False, type="list", default=None),
|
runasuser=dict(required=False, type="list", elements="str",
|
||||||
runasgroup=dict(required=False, type="list", default=None),
|
default=None),
|
||||||
|
runasgroup=dict(required=False, type="list", elements="str",
|
||||||
|
default=None),
|
||||||
order=dict(type="int", required=False, aliases=['sudoorder']),
|
order=dict(type="int", required=False, aliases=['sudoorder']),
|
||||||
sudooption=dict(required=False, type='list', default=None,
|
sudooption=dict(required=False, type='list', elements="str",
|
||||||
aliases=["options"]),
|
default=None, aliases=["options"]),
|
||||||
action=dict(type="str", default="sudorule",
|
action=dict(type="str", default="sudorule",
|
||||||
choices=["member", "sudorule"]),
|
choices=["member", "sudorule"]),
|
||||||
# state
|
# state
|
||||||
|
|||||||
Reference in New Issue
Block a user