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

ipaserver_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)`

RETURN section

- `type: str` needs to be used for string parameters

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_server.check_imports has been added to check for import
errors.

The `copyright` date is extended with `-2022`.
parent 03e9dd3f
Branches
Tags
No related merge requests found
......@@ -5,7 +5,7 @@
#
# 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
#
# This program is free software; you can redistribute it and/or modify
......@@ -40,12 +40,14 @@ description:
options:
dm_password:
description: Directory Manager password
required: no
type: str
required: yes
master_password:
description: kerberos master password (normally autogenerated)
required: yes
type: str
required: no
author:
- Thomas Woerner
- Thomas Woerner (@t-woerner)
'''
EXAMPLES = '''
......@@ -54,6 +56,7 @@ EXAMPLES = '''
RETURN = '''
password:
description: The master password
type: str
returned: always
'''
......@@ -61,6 +64,7 @@ import os
from ansible.module_utils.basic import AnsibleModule
from ansible.module_utils.ansible_ipa_server import (
check_imports,
setup_logging, options, paths, read_cache, ipa_generate_password
)
......@@ -69,13 +73,14 @@ def main():
module = AnsibleModule(
argument_spec=dict(
# basic
dm_password=dict(required=True, no_log=True),
master_password=dict(required=False, no_log=True),
dm_password=dict(required=True, type='str', 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
check_imports(module)
setup_logging()
options.dm_password = module.params.get('dm_password')
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment