ipaclient_setup_krb5: 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
- `required` tags need to be fixed according to the `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`.
This commit is contained in:
Thomas Woerner
2022-11-07 13:55:01 +01:00
parent 1239109e43
commit 0f724598a8

View File

@@ -5,7 +5,7 @@
# #
# Based on ipa-client-install code # Based on ipa-client-install code
# #
# Copyright (C) 2018 Red Hat # Copyright (C) 2018-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
@@ -40,33 +40,46 @@ description:
options: options:
domain: domain:
description: Primary DNS domain of the IPA deployment description: Primary DNS domain of the IPA deployment
required: yes type: str
required: no
servers: servers:
description: Fully qualified name of IPA servers to enroll to description: Fully qualified name of IPA servers to enroll to
required: yes type: list
elements: str
required: no
realm: realm:
description: Kerberos realm name of the IPA deployment description: Kerberos realm name of the IPA deployment
required: yes type: str
required: no
hostname: hostname:
description: Fully qualified name of this host description: Fully qualified name of this host
required: yes type: str
required: no
kdc: kdc:
description: The name or address of the host running the KDC description: The name or address of the host running the KDC
required: yes type: str
required: no
dnsok: dnsok:
description: The installer dnsok setting description: The installer dnsok setting
required: yes type: bool
required: no
default: no
client_domain: client_domain:
description: Primary DNS domain of the IPA deployment description: Primary DNS domain of the IPA deployment
required: yes type: str
required: no
sssd: sssd:
description: The installer sssd setting description: The installer sssd setting
required: yes type: bool
required: no
default: no
force: force:
description: Installer force parameter description: Installer force parameter
required: yes type: bool
required: no
default: no
author: author:
- Thomas Woerner - Thomas Woerner (@t-woerner)
''' '''
EXAMPLES = ''' EXAMPLES = '''
@@ -84,28 +97,31 @@ RETURN = '''
from ansible.module_utils.basic import AnsibleModule from ansible.module_utils.basic import AnsibleModule
from ansible.module_utils.ansible_ipa_client import ( from ansible.module_utils.ansible_ipa_client import (
setup_logging, sysrestore, paths, configure_krb5_conf, logger setup_logging, check_imports, sysrestore, paths, configure_krb5_conf,
logger
) )
def main(): def main():
module = AnsibleModule( module = AnsibleModule(
argument_spec=dict( argument_spec=dict(
domain=dict(required=False, default=None), domain=dict(required=False, type='str', default=None),
servers=dict(required=False, type='list', default=None), servers=dict(required=False, type='list', elements='str',
realm=dict(required=False, default=None), default=None),
hostname=dict(required=False, default=None), realm=dict(required=False, type='str', default=None),
kdc=dict(required=False, default=None), hostname=dict(required=False, type='str', default=None),
kdc=dict(required=False, type='str', default=None),
dnsok=dict(required=False, type='bool', default=False), dnsok=dict(required=False, type='bool', default=False),
client_domain=dict(required=False, default=None), client_domain=dict(required=False, type='str', default=None),
sssd=dict(required=False, type='bool', default=False), sssd=dict(required=False, type='bool', default=False),
force=dict(required=False, type='bool', default=False), force=dict(required=False, type='bool', default=False),
# on_master=dict(required=False, type='bool', default=False), # on_master=dict(required=False, type='bool', default=False),
), ),
supports_check_mode=True, supports_check_mode=False,
) )
module._ansible_debug = True module._ansible_debug = True
check_imports(module)
setup_logging() setup_logging()
servers = module.params.get('servers') servers = module.params.get('servers')