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

ipaclient_fstore: 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
- `required` tags need to be fixed according to the `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

A call to ansible_ipa_client.check_imports has been added to check for import
errors.

The `copyright` date is extended with `-2022`.
parent 97a7232b
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
...@@ -39,9 +39,10 @@ description: Backup files using IPA client sysrestore ...@@ -39,9 +39,10 @@ description: Backup files using IPA client sysrestore
options: options:
backup: backup:
description: File to backup description: File to backup
required: no type: str
required: yes
author: author:
- Thomas Woerner - Thomas Woerner (@t-woerner)
''' '''
EXAMPLES = ''' EXAMPLES = '''
...@@ -55,18 +56,19 @@ RETURN = ''' ...@@ -55,18 +56,19 @@ 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, paths, sysrestore setup_logging, check_imports, paths, sysrestore
) )
def main(): def main():
module = AnsibleModule( module = AnsibleModule(
argument_spec=dict( argument_spec=dict(
backup=dict(required=True), backup=dict(required=True, type='str'),
), ),
) )
module._ansible_debug = True module._ansible_debug = True
check_imports(module)
setup_logging() setup_logging()
backup = module.params.get('backup') backup = module.params.get('backup')
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment