mirror of
https://github.com/freeipa/ansible-freeipa.git
synced 2026-05-07 05:43:26 +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'
104 lines
2.5 KiB
Python
104 lines
2.5 KiB
Python
# -*- coding: utf-8 -*-
|
|
|
|
# Authors:
|
|
# Thomas Woerner <twoerner@redhat.com>
|
|
#
|
|
# Copyright (C) 2019 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: ipatopologysuffix
|
|
short_description: Verify FreeIPA topology suffix
|
|
description: Verify FreeIPA topology suffix
|
|
extends_documentation_fragment:
|
|
- ipamodule_base_docs
|
|
options:
|
|
suffix:
|
|
description: Topology suffix
|
|
required: true
|
|
choices: ["domain", "ca"]
|
|
state:
|
|
description: State to ensure
|
|
default: verified
|
|
choices: ["verified"]
|
|
author:
|
|
- Thomas Woerner
|
|
"""
|
|
|
|
EXAMPLES = """
|
|
- ipatopologysuffix:
|
|
ipaadmin_password: SomeADMINpassword
|
|
suffix: domain
|
|
state: verified
|
|
"""
|
|
|
|
RETURN = """
|
|
"""
|
|
|
|
from ansible.module_utils.ansible_freeipa_module import IPAAnsibleModule
|
|
|
|
|
|
def main():
|
|
ansible_module = IPAAnsibleModule(
|
|
argument_spec=dict(
|
|
suffix=dict(choices=["domain", "ca"], required=True),
|
|
state=dict(type="str", default="verified",
|
|
choices=["verified"]),
|
|
),
|
|
supports_check_mode=True,
|
|
)
|
|
|
|
ansible_module._ansible_debug = True
|
|
|
|
# Get parameters
|
|
|
|
suffix = ansible_module.params_get("suffix")
|
|
state = ansible_module.params_get("state")
|
|
|
|
# Check parameters
|
|
|
|
# Init
|
|
|
|
# Create command
|
|
|
|
if state not in ["verified"]:
|
|
ansible_module.fail_json(msg="Unkown state '%s'" % state)
|
|
|
|
# Execute command
|
|
|
|
with ansible_module.ipa_connect():
|
|
# Execute command
|
|
ansible_module.ipa_command("topologysuffix_verify", suffix, {})
|
|
|
|
# Done
|
|
|
|
ansible_module.exit_json(changed=True)
|
|
|
|
|
|
if __name__ == "__main__":
|
|
main()
|