mirror of
https://github.com/freeipa/ansible-freeipa.git
synced 2026-07-28 18:34:44 +00:00
ipaserver_enable_ipa: 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` - `type` 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 A call to ansible_ipa_server.check_imports has been added to check for import errors. The `copyright` date is extended with `-2022`.
This commit is contained in:
@@ -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
|
||||||
@@ -39,15 +39,18 @@ description: Enable IPA
|
|||||||
options:
|
options:
|
||||||
hostname:
|
hostname:
|
||||||
description: Fully qualified name of this host
|
description: Fully qualified name of this host
|
||||||
required: yes
|
type: str
|
||||||
|
required: no
|
||||||
setup_dns:
|
setup_dns:
|
||||||
description: Configure bind with our zone
|
description: Configure bind with our zone
|
||||||
required: no
|
type: bool
|
||||||
|
required: yes
|
||||||
setup_ca:
|
setup_ca:
|
||||||
description: Configure a dogtag CA
|
description: Configure a dogtag CA
|
||||||
required: no
|
type: bool
|
||||||
|
required: yes
|
||||||
author:
|
author:
|
||||||
- Thomas Woerner
|
- Thomas Woerner (@t-woerner)
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
@@ -58,6 +61,7 @@ RETURN = '''
|
|||||||
|
|
||||||
from ansible.module_utils.basic import AnsibleModule
|
from ansible.module_utils.basic import AnsibleModule
|
||||||
from ansible.module_utils.ansible_ipa_server import (
|
from ansible.module_utils.ansible_ipa_server import (
|
||||||
|
check_imports,
|
||||||
AnsibleModuleLog, setup_logging, options, paths, api, sysrestore, tasks,
|
AnsibleModuleLog, setup_logging, options, paths, api, sysrestore, tasks,
|
||||||
service, bindinstance, redirect_stdout, services
|
service, bindinstance, redirect_stdout, services
|
||||||
)
|
)
|
||||||
@@ -66,13 +70,14 @@ from ansible.module_utils.ansible_ipa_server import (
|
|||||||
def main():
|
def main():
|
||||||
ansible_module = AnsibleModule(
|
ansible_module = AnsibleModule(
|
||||||
argument_spec=dict(
|
argument_spec=dict(
|
||||||
hostname=dict(required=False),
|
hostname=dict(required=False, type='str'),
|
||||||
setup_dns=dict(required=True, type='bool'),
|
setup_dns=dict(required=True, type='bool'),
|
||||||
setup_ca=dict(required=True, type='bool'),
|
setup_ca=dict(required=True, type='bool'),
|
||||||
),
|
),
|
||||||
)
|
)
|
||||||
|
|
||||||
ansible_module._ansible_debug = True
|
ansible_module._ansible_debug = True
|
||||||
|
check_imports(ansible_module)
|
||||||
setup_logging()
|
setup_logging()
|
||||||
ansible_log = AnsibleModuleLog(ansible_module)
|
ansible_log = AnsibleModuleLog(ansible_module)
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user