mirror of
https://github.com/freeipa/ansible-freeipa.git
synced 2026-07-30 11:24:50 +00:00
ipaautomountmap: 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 need to be consistent to `argument_spec` - `extends_documentation_fragment: ipamodule_base_docs` needs added and `ipaadmin_*` parameters need to be removed argument_spec - `elements="str"` needs to be added to all list of string parameters - `default=.*` needs to be dropped if `required=True` is also given The `copyright` date is extended with `-2022`.
This commit is contained in:
@@ -2,8 +2,9 @@
|
|||||||
# -*- coding: utf-8 -*-
|
# -*- coding: utf-8 -*-
|
||||||
# Authors:
|
# Authors:
|
||||||
# Chris Procter <cprocter@redhat.com>
|
# Chris Procter <cprocter@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
|
||||||
@@ -33,31 +34,34 @@ ANSIBLE_METADATA = {
|
|||||||
DOCUMENTATION = '''
|
DOCUMENTATION = '''
|
||||||
---
|
---
|
||||||
module: ipaautomountmap
|
module: ipaautomountmap
|
||||||
author: Chris Procter
|
author:
|
||||||
|
- Chris Procter (@chr15p)
|
||||||
|
- Thomas Woerner (@t-woerner)
|
||||||
short_description: Manage FreeIPA autommount map
|
short_description: Manage FreeIPA autommount map
|
||||||
description:
|
description:
|
||||||
- Add, delete, and modify an IPA automount map
|
- Add, delete, and modify an IPA automount map
|
||||||
|
extends_documentation_fragment:
|
||||||
|
- ipamodule_base_docs
|
||||||
options:
|
options:
|
||||||
ipaadmin_principal:
|
|
||||||
description: The admin principal.
|
|
||||||
default: admin
|
|
||||||
ipaadmin_password:
|
|
||||||
description: The admin password.
|
|
||||||
required: false
|
|
||||||
automountlocation:
|
automountlocation:
|
||||||
description: automount location map is anchored to
|
description: automount location map is anchored to
|
||||||
choices: ["location", "automountlocationcn"]
|
type: str
|
||||||
|
aliases: ["location", "automountlocationcn"]
|
||||||
required: True
|
required: True
|
||||||
name:
|
name:
|
||||||
description: automount map to be managed.
|
description: automount map to be managed.
|
||||||
choices: ["mapname", "map", "automountmapname"]
|
type: list
|
||||||
|
elements: str
|
||||||
|
aliases: ["mapname", "map", "automountmapname"]
|
||||||
required: True
|
required: True
|
||||||
desc:
|
desc:
|
||||||
description: description of automount map.
|
description: description of automount map.
|
||||||
choices: ["description"]
|
type: str
|
||||||
|
aliases: ["description"]
|
||||||
required: false
|
required: false
|
||||||
state:
|
state:
|
||||||
description: State to ensure
|
description: State to ensure
|
||||||
|
type: str
|
||||||
required: false
|
required: false
|
||||||
default: present
|
default: present
|
||||||
choices: ["present", "absent"]
|
choices: ["present", "absent"]
|
||||||
@@ -169,12 +173,10 @@ def main():
|
|||||||
),
|
),
|
||||||
location=dict(type="str",
|
location=dict(type="str",
|
||||||
aliases=["automountlocation", "automountlocationcn"],
|
aliases=["automountlocation", "automountlocationcn"],
|
||||||
default=None,
|
|
||||||
required=True
|
required=True
|
||||||
),
|
),
|
||||||
name=dict(type="list",
|
name=dict(type="list", elements="str",
|
||||||
aliases=["mapname", "map", "automountmapname"],
|
aliases=["mapname", "map", "automountmapname"],
|
||||||
default=None,
|
|
||||||
required=True
|
required=True
|
||||||
),
|
),
|
||||||
desc=dict(type="str",
|
desc=dict(type="str",
|
||||||
|
|||||||
Reference in New Issue
Block a user