From e152259757c6674995fc1df8b1c4465ea5899011 Mon Sep 17 00:00:00 2001
From: Thomas Woerner <twoerner@redhat.com>
Date: Mon, 7 Nov 2022 14:00:21 +0100
Subject: [PATCH] ipaclient_setup_ssh: 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`
- `default` 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`.
---
.../ipaclient/library/ipaclient_setup_ssh.py | 31 +++++++++++++------
1 file changed, 21 insertions(+), 10 deletions(-)
diff --git a/roles/ipaclient/library/ipaclient_setup_ssh.py b/roles/ipaclient/library/ipaclient_setup_ssh.py
index 8da49cdc..412e5a6d 100644
--- a/roles/ipaclient/library/ipaclient_setup_ssh.py
+++ b/roles/ipaclient/library/ipaclient_setup_ssh.py
@@ -5,7 +5,7 @@
#
# 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
#
# This program is free software; you can redistribute it and/or modify
@@ -40,21 +40,31 @@ description:
options:
servers:
description: Fully qualified name of IPA servers to enroll to
- required: no
+ type: list
+ elements: str
+ required: yes
no_ssh:
description: Do not configure OpenSSH client
- required: yes
+ type: bool
+ required: no
+ default: no
ssh_trust_dns:
description: Configure OpenSSH client to trust DNS SSHFP records
- required: yes
+ type: bool
+ required: no
+ default: no
no_sshd:
description: Do not configure OpenSSH server
- required: yes
+ type: bool
+ required: no
+ default: no
sssd:
description: The installer sssd setting
- required: yes
+ type: bool
+ required: no
+ default: no
author:
- - Thomas Woerner
+ - Thomas Woerner (@t-woerner)
'''
EXAMPLES = '''
@@ -71,7 +81,7 @@ RETURN = '''
from ansible.module_utils.basic import AnsibleModule
from ansible.module_utils.ansible_ipa_client import (
- setup_logging,
+ setup_logging, check_imports,
options, sysrestore, paths, configure_ssh_config, configure_sshd_config
)
@@ -79,16 +89,17 @@ from ansible.module_utils.ansible_ipa_client import (
def main():
module = AnsibleModule(
argument_spec=dict(
- servers=dict(required=True, type='list'),
+ servers=dict(required=True, type='list', elements='str'),
no_ssh=dict(required=False, type='bool', default='no'),
ssh_trust_dns=dict(required=False, type='bool', default='no'),
no_sshd=dict(required=False, type='bool', default='no'),
sssd=dict(required=False, type='bool', default='no'),
),
- supports_check_mode=True,
+ supports_check_mode=False,
)
module._ansible_debug = True
+ check_imports(module)
setup_logging()
options.servers = module.params.get('servers')
--
GitLab