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

ipaclient_setup_sssd: 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

- `module` tag needs to be correct
- `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`.
parent e1522597
No related branches found
No related tags found
No related merge requests found
...@@ -5,7 +5,7 @@ ...@@ -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
...@@ -33,60 +33,75 @@ ANSIBLE_METADATA = { ...@@ -33,60 +33,75 @@ ANSIBLE_METADATA = {
DOCUMENTATION = ''' DOCUMENTATION = '''
--- ---
module: ipaclient_setup_ssd module: ipaclient_setup_sssd
short_description: Setup sssd for IPA client short_description: Setup sssd for IPA client
description: description:
Setup sssd for IPA client Setup sssd for IPA client
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
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
no_ssh: no_ssh:
description: Do not configure OpenSSH client description: Do not configure OpenSSH client
required: yes type: bool
required: no
no_sshd: no_sshd:
description: Do not configure OpenSSH server description: Do not configure OpenSSH server
required: yes type: bool
required: no
no_sudo: no_sudo:
description: Do not configure SSSD as data source for sudo description: Do not configure SSSD as data source for sudo
required: yes type: bool
required: no
all_ip_addresses: all_ip_addresses:
description: description:
All routable IP addresses configured on any interface will be added All routable IP addresses configured on any interface will be added
to DNS to DNS
required: yes type: bool
required: no
fixed_primary: fixed_primary:
description: Configure sssd to use fixed server as primary IPA server description: Configure sssd to use fixed server as primary IPA server
required: yes type: bool
required: no
permit: permit:
description: Disable access rules by default, permit all access description: Disable access rules by default, permit all access
required: yes type: bool
required: no
enable_dns_updates: enable_dns_updates:
description: description:
Configures the machine to attempt dns updates when the ip address Configures the machine to attempt dns updates when the ip address
changes changes
required: yes type: bool
required: no
preserve_sssd: preserve_sssd:
description: Preserve old SSSD configuration if possible description: Preserve old SSSD configuration if possible
required: yes type: bool
required: no
no_krb5_offline_passwords: no_krb5_offline_passwords:
description: description:
Configure SSSD not to store user password when the server is offline Configure SSSD not to store user password when the server is offline
required: yes type: bool
required: no
author: author:
- Thomas Woerner - Thomas Woerner (@t-woerner)
''' '''
EXAMPLES = ''' EXAMPLES = '''
...@@ -104,17 +119,18 @@ RETURN = ''' ...@@ -104,17 +119,18 @@ 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, options, sysrestore, paths, configure_sssd_conf, logger setup_logging, check_imports, options, sysrestore, paths,
configure_sssd_conf, logger
) )
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'),
on_master=dict(required=False, type='bool'), on_master=dict(required=False, type='bool'),
no_ssh=dict(required=False, type='bool'), no_ssh=dict(required=False, type='bool'),
no_sshd=dict(required=False, type='bool'), no_sshd=dict(required=False, type='bool'),
...@@ -127,12 +143,13 @@ def main(): ...@@ -127,12 +143,13 @@ def main():
preserve_sssd=dict(required=False, type='bool'), preserve_sssd=dict(required=False, type='bool'),
no_krb5_offline_passwords=dict(required=False, type='bool'), no_krb5_offline_passwords=dict(required=False, type='bool'),
), ),
supports_check_mode=True, supports_check_mode=False,
) )
# ansible_log = AnsibleModuleLog(module, logger) # ansible_log = AnsibleModuleLog(module, logger)
# options.set_logger(ansible_log) # options.set_logger(ansible_log)
module._ansible_debug = True module._ansible_debug = True
check_imports(module)
setup_logging() setup_logging()
cli_server = module.params.get('servers') cli_server = module.params.get('servers')
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment