mirror of
https://github.com/freeipa/ansible-freeipa.git
synced 2026-07-31 03:44:41 +00:00
ipaclient_setup_ntp: 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` - `author` needs to be given with the github user also: `Name (@user)` 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
|
||||||
@@ -40,24 +40,34 @@ description:
|
|||||||
options:
|
options:
|
||||||
ntp_servers:
|
ntp_servers:
|
||||||
description: ntp servers to use
|
description: ntp servers to use
|
||||||
required: yes
|
type: list
|
||||||
|
elements: str
|
||||||
|
required: no
|
||||||
ntp_pool:
|
ntp_pool:
|
||||||
description: ntp server pool to use
|
description: ntp server pool to use
|
||||||
required: yes
|
type: str
|
||||||
|
required: no
|
||||||
no_ntp:
|
no_ntp:
|
||||||
description: Do not configure ntp
|
description: Do not configure ntp
|
||||||
required: yes
|
type: bool
|
||||||
|
required: no
|
||||||
|
default: no
|
||||||
on_master:
|
on_master:
|
||||||
description: Whether the configuration is done on the master or not
|
description: Whether the configuration is done on the master or not
|
||||||
required: yes
|
type: bool
|
||||||
|
required: no
|
||||||
|
default: no
|
||||||
servers:
|
servers:
|
||||||
description: Fully qualified name of IPA servers to enroll to
|
description: Fully qualified name of IPA servers to enroll to
|
||||||
required: yes
|
type: list
|
||||||
|
elements: str
|
||||||
|
required: no
|
||||||
domain:
|
domain:
|
||||||
description: Primary DNS domain of the IPA deployment
|
description: Primary DNS domain of the IPA deployment
|
||||||
required: yes
|
type: str
|
||||||
|
required: no
|
||||||
author:
|
author:
|
||||||
- Thomas Woerner
|
- Thomas Woerner (@t-woerner)
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
@@ -68,7 +78,7 @@ RETURN = '''
|
|||||||
|
|
||||||
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,
|
||||||
options, sysrestore, paths, sync_time, logger, ipadiscovery,
|
options, sysrestore, paths, sync_time, logger, ipadiscovery,
|
||||||
timeconf, getargspec
|
timeconf, getargspec
|
||||||
)
|
)
|
||||||
@@ -78,19 +88,22 @@ def main():
|
|||||||
module = AnsibleModule(
|
module = AnsibleModule(
|
||||||
argument_spec=dict(
|
argument_spec=dict(
|
||||||
# basic
|
# basic
|
||||||
ntp_servers=dict(required=False, type='list', default=None),
|
ntp_servers=dict(required=False, type='list', elements='str',
|
||||||
ntp_pool=dict(required=False, default=None),
|
default=None),
|
||||||
|
ntp_pool=dict(required=False, type='str', default=None),
|
||||||
no_ntp=dict(required=False, type='bool', default=False),
|
no_ntp=dict(required=False, type='bool', default=False),
|
||||||
# force_ntpd=dict(required=False, type='bool', default=False),
|
# force_ntpd=dict(required=False, type='bool', default=False),
|
||||||
on_master=dict(required=False, type='bool', default=False),
|
on_master=dict(required=False, type='bool', default=False),
|
||||||
# additional
|
# additional
|
||||||
servers=dict(required=False, type='list', default=None),
|
servers=dict(required=False, type='list', elements='str',
|
||||||
domain=dict(required=False, default=None),
|
default=None),
|
||||||
|
domain=dict(required=False, type='str', default=None),
|
||||||
),
|
),
|
||||||
supports_check_mode=True,
|
supports_check_mode=False,
|
||||||
)
|
)
|
||||||
|
|
||||||
# module._ansible_debug = True
|
# module._ansible_debug = True
|
||||||
|
check_imports(module)
|
||||||
setup_logging()
|
setup_logging()
|
||||||
|
|
||||||
options.ntp_servers = module.params.get('ntp_servers')
|
options.ntp_servers = module.params.get('ntp_servers')
|
||||||
|
|||||||
Reference in New Issue
Block a user