mirror of
https://github.com/freeipa/ansible-freeipa.git
synced 2026-07-31 20:04:45 +00:00
ipaclient_api: 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` - `author` needs to be given with the github user also: `Name (@user)` RETURN section - `type: string` is not valid and needs to be replaced by `type: str` argument_spec - `elements='str'` needs to be added to all list of string parameters - `elements='dict'` needs to be added to all list of dict parameters 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:
@@ -5,7 +5,7 @@
|
|||||||
#
|
#
|
||||||
# Based on ipa-client-install code
|
# 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
|
# 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,18 +39,24 @@ description:
|
|||||||
options:
|
options:
|
||||||
servers:
|
servers:
|
||||||
description: Fully qualified name of IPA servers to enroll to
|
description: Fully qualified name of IPA servers to enroll to
|
||||||
required: no
|
type: list
|
||||||
|
elements: str
|
||||||
|
required: yes
|
||||||
realm:
|
realm:
|
||||||
description: Kerberos realm name of the IPA deployment
|
description: Kerberos realm name of the IPA deployment
|
||||||
required: no
|
type: str
|
||||||
|
required: yes
|
||||||
hostname:
|
hostname:
|
||||||
description: Fully qualified name of this host
|
description: Fully qualified name of this host
|
||||||
required: no
|
type: str
|
||||||
|
required: yes
|
||||||
debug:
|
debug:
|
||||||
description: Turn on extra debugging
|
description: Turn on extra debugging
|
||||||
required: yes
|
type: bool
|
||||||
|
required: no
|
||||||
|
default: no
|
||||||
author:
|
author:
|
||||||
- Thomas Woerner
|
- Thomas Woerner (@t-woerner)
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
@@ -70,7 +76,7 @@ ca_enabled:
|
|||||||
subject_base:
|
subject_base:
|
||||||
description: The subject base, needed for certmonger
|
description: The subject base, needed for certmonger
|
||||||
returned: always
|
returned: always
|
||||||
type: string
|
type: str
|
||||||
sample: O=EXAMPLE.COM
|
sample: O=EXAMPLE.COM
|
||||||
'''
|
'''
|
||||||
|
|
||||||
@@ -78,7 +84,7 @@ import os
|
|||||||
|
|
||||||
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,
|
setup_logging, check_imports,
|
||||||
paths, x509, NUM_VERSION, serialization, certdb, api,
|
paths, x509, NUM_VERSION, serialization, certdb, api,
|
||||||
delete_persistent_client_session_data, write_tmp_file,
|
delete_persistent_client_session_data, write_tmp_file,
|
||||||
ipa_generate_password, CalledProcessError, errors, disable_ra, DN,
|
ipa_generate_password, CalledProcessError, errors, disable_ra, DN,
|
||||||
@@ -89,15 +95,16 @@ from ansible.module_utils.ansible_ipa_client import (
|
|||||||
def main():
|
def main():
|
||||||
module = AnsibleModule(
|
module = AnsibleModule(
|
||||||
argument_spec=dict(
|
argument_spec=dict(
|
||||||
servers=dict(required=True, type='list'),
|
servers=dict(required=True, type='list', elements='str'),
|
||||||
realm=dict(required=True),
|
realm=dict(required=True, type='str'),
|
||||||
hostname=dict(required=True),
|
hostname=dict(required=True, type='str'),
|
||||||
debug=dict(required=False, type='bool', default="false"),
|
debug=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()
|
||||||
|
|
||||||
realm = module.params.get('realm')
|
realm = module.params.get('realm')
|
||||||
|
|||||||
Reference in New Issue
Block a user