mirror of
https://github.com/freeipa/ansible-freeipa.git
synced 2026-07-29 10:54:44 +00:00
ipaclient_test_keytab: 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` - `type` tag needs to match `argument_spec` - `default` tag needs to match `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 - `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:
@@ -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
|
||||||
@@ -42,24 +42,31 @@ 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
|
||||||
domain:
|
domain:
|
||||||
description: Primary DNS domain of the IPA deployment
|
description: Primary DNS domain of the IPA deployment
|
||||||
required: no
|
type: 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
|
||||||
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: no
|
type: str
|
||||||
|
required: yes
|
||||||
kinit_attempts:
|
kinit_attempts:
|
||||||
description: Repeat the request for host Kerberos ticket X times
|
description: Repeat the request for host Kerberos ticket X times
|
||||||
required: yes
|
type: int
|
||||||
|
default: 5
|
||||||
author:
|
author:
|
||||||
- Thomas Woerner
|
- Thomas Woerner (@t-woerner)
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
@@ -91,6 +98,7 @@ krb5_keytab_ok:
|
|||||||
ca_crt_exists:
|
ca_crt_exists:
|
||||||
description: The flag describes if ca.crt exists.
|
description: The flag describes if ca.crt exists.
|
||||||
returned: always
|
returned: always
|
||||||
|
type: str
|
||||||
krb5_conf_ok:
|
krb5_conf_ok:
|
||||||
description: The flag describes if krb5.conf on the host is usable.
|
description: The flag describes if krb5.conf on the host is usable.
|
||||||
returned: always
|
returned: always
|
||||||
@@ -106,7 +114,7 @@ import tempfile
|
|||||||
|
|
||||||
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,
|
||||||
SECURE_PATH, paths, kinit_keytab, run, GSSError, configure_krb5_conf
|
SECURE_PATH, paths, kinit_keytab, run, GSSError, configure_krb5_conf
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -114,17 +122,18 @@ 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'),
|
||||||
domain=dict(required=True),
|
domain=dict(required=True, type='str'),
|
||||||
realm=dict(required=True),
|
realm=dict(required=True, type='str'),
|
||||||
hostname=dict(required=True),
|
hostname=dict(required=True, type='str'),
|
||||||
kdc=dict(required=True),
|
kdc=dict(required=True, type='str'),
|
||||||
kinit_attempts=dict(required=False, type='int', default=5),
|
kinit_attempts=dict(required=False, type='int', default=5),
|
||||||
),
|
),
|
||||||
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')
|
||||||
|
|||||||
Reference in New Issue
Block a user