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

ipaclient_setup_automount: 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
- `required` tags need to be fixed according to the `argument_spec`
- `type` tag needs to match `argument_spec`
- `default` tag needs to match `argument_spec`
- `author` needs to be given with the github user also: `Name (@user)`

argument_spec

- `type='str'` needs to be set for string parameters
- `elements='str'` needs to be added to all list of string parameters

supports_check_mode is turned off as it is not supported.

A call to ansible_ipa_client.check_imports has been added to check for import
errors.

The `copyright` date is extended with `-2022`.
parent 923cd9f5
No related branches found
No related tags found
No related merge requests found
......@@ -5,7 +5,7 @@
#
# Based on ipa-client-install code
#
# Copyright (C) 2017 Red Hat
# Copyright (C) 2017-2022 Red Hat
# see file 'COPYING' for use and warranty information
#
# This program is free software; you can redistribute it and/or modify
......@@ -40,15 +40,20 @@ description:
options:
servers:
description: Fully qualified name of IPA servers to enroll to
required: no
type: list
elements: str
required: yes
sssd:
description: The installer sssd setting
required: yes
type: bool
required: no
default: yes
automount_location:
description: The automount location
required: yes
type: str
required: no
author:
- Thomas Woerner
- Thomas Woerner (@t-woerner)
'''
EXAMPLES = '''
......@@ -63,23 +68,24 @@ RETURN = '''
from ansible.module_utils.basic import AnsibleModule
from ansible.module_utils.ansible_ipa_client import (
setup_logging, options, configure_automount
setup_logging, check_imports, options, configure_automount
)
def main():
module = AnsibleModule(
argument_spec=dict(
servers=dict(required=True, type='list'),
servers=dict(required=True, type='list', elements='str'),
sssd=dict(required=False, type='bool', default='yes'),
automount_location=dict(required=False, default=None),
automount_location=dict(required=False, type='str', default=None),
),
supports_check_mode=True,
supports_check_mode=False,
)
# os.environ['KRB5CCNAME'] = paths.IPA_DNS_CCACHE
module._ansible_debug = True
check_imports(module)
setup_logging()
options.servers = module.params.get('servers')
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment