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

ipareplica_master_password: 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
- `required` tags need to be fixed according to the `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

supports_check_mode is turned off as it is not supported.

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

The `copyright` date is extended with `-2022`.
parent 1a809544
No related branches found
No related tags found
No related merge requests found
...@@ -5,7 +5,7 @@ ...@@ -5,7 +5,7 @@
# #
# Based on ipa-server-install code # Based on ipa-server-install code
# #
# Copyright (C) 2017 Red Hat # Copyright (C) 2017-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,9 +40,10 @@ description: ...@@ -40,9 +40,10 @@ description:
options: options:
master_password: master_password:
description: kerberos master password (normally autogenerated) description: kerberos master password (normally autogenerated)
required: yes type: str
required: no
author: author:
- Thomas Woerner - Thomas Woerner (@t-woerner)
''' '''
EXAMPLES = ''' EXAMPLES = '''
...@@ -51,12 +52,13 @@ EXAMPLES = ''' ...@@ -51,12 +52,13 @@ EXAMPLES = '''
RETURN = ''' RETURN = '''
password: password:
description: The master password description: The master password
type: str
returned: always returned: always
''' '''
from ansible.module_utils.basic import AnsibleModule from ansible.module_utils.basic import AnsibleModule
from ansible.module_utils.ansible_ipa_replica import ( from ansible.module_utils.ansible_ipa_replica import (
setup_logging, ipa_generate_password check_imports, setup_logging, ipa_generate_password
) )
...@@ -64,12 +66,13 @@ def main(): ...@@ -64,12 +66,13 @@ def main():
module = AnsibleModule( module = AnsibleModule(
argument_spec=dict( argument_spec=dict(
# basic # basic
master_password=dict(required=False, no_log=True), master_password=dict(required=False, type='str', no_log=True),
), ),
supports_check_mode=True, supports_check_mode=False,
) )
module._ansible_debug = True module._ansible_debug = True
check_imports(module)
setup_logging() setup_logging()
master_password = module.params.get('master_password') master_password = module.params.get('master_password')
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment