mirror of
https://github.com/freeipa/ansible-freeipa.git
synced 2026-06-10 02:35:54 +00:00
81143be96a
Before "short description" was used in most plugins, modules and also in the new module templates. ansible-doc was therefore not showing the short description. To fix the issue the flag was renamed to short_description instead. Fixes: https://bugzilla.redhat.com/show_bug.cgi?id=2121362 'ansible-doc' -l lists most idm modules as 'UNDOCUMENTED'
74 lines
1.8 KiB
Python
74 lines
1.8 KiB
Python
# -*- coding: utf-8 -*-
|
|
|
|
# Authors:
|
|
# Thomas Woerner <twoerner@redhat.com>
|
|
#
|
|
# Copyright (C) 2021 Red Hat
|
|
# see file 'COPYING' for use and warranty information
|
|
#
|
|
# This program is free software; you can redistribute it and/or modify
|
|
# it under the terms of the GNU General Public License as published by
|
|
# the Free Software Foundation, either version 3 of the License, or
|
|
# (at your option) any later version.
|
|
#
|
|
# This program is distributed in the hope that it will be useful,
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
# GNU General Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU General Public License
|
|
# along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
from __future__ import (absolute_import, division, print_function)
|
|
|
|
__metaclass__ = type
|
|
|
|
ANSIBLE_METADATA = {
|
|
'metadata_version': '1.0',
|
|
'supported_by': 'community',
|
|
'status': ['preview'],
|
|
}
|
|
|
|
DOCUMENTATION = '''
|
|
---
|
|
module: ipabackup_get_backup_dir
|
|
short_description:
|
|
Get IPA_BACKUP_DIR from ipaplatform
|
|
description:
|
|
Get IPA_BACKUP_DIR from ipaplatform
|
|
options:
|
|
author:
|
|
- Thomas Woerner
|
|
'''
|
|
|
|
EXAMPLES = '''
|
|
# Get IPA_BACKUP_DIR from ipaplatform
|
|
- name: Get IPA_BACKUP_DIR from ipaplatform
|
|
ipabackup_get_backup_dir:
|
|
register: result
|
|
'''
|
|
|
|
RETURN = '''
|
|
backup_dir:
|
|
description: IPA_BACKUP_DIR from ipaplatform
|
|
returned: always
|
|
type: str
|
|
'''
|
|
|
|
from ansible.module_utils.basic import AnsibleModule
|
|
from ipaplatform.paths import paths
|
|
|
|
|
|
def main():
|
|
module = AnsibleModule(
|
|
argument_spec={},
|
|
supports_check_mode=True,
|
|
)
|
|
|
|
module.exit_json(changed=False,
|
|
backup_dir=paths.IPA_BACKUP_DIR)
|
|
|
|
|
|
if __name__ == '__main__':
|
|
main()
|