|
Packit |
8cb997 |
#!/usr/bin/python
|
|
Packit |
8cb997 |
# -*- coding: utf-8 -*-
|
|
Packit |
8cb997 |
|
|
Packit |
8cb997 |
# Authors:
|
|
Packit |
8cb997 |
# Thomas Woerner <twoerner@redhat.com>
|
|
Packit |
8cb997 |
#
|
|
Packit |
8cb997 |
# Copyright (C) 2019 Red Hat
|
|
Packit |
8cb997 |
# see file 'COPYING' for use and warranty information
|
|
Packit |
8cb997 |
#
|
|
Packit |
8cb997 |
# This program is free software; you can redistribute it and/or modify
|
|
Packit |
8cb997 |
# it under the terms of the GNU General Public License as published by
|
|
Packit |
8cb997 |
# the Free Software Foundation, either version 3 of the License, or
|
|
Packit |
8cb997 |
# (at your option) any later version.
|
|
Packit |
8cb997 |
#
|
|
Packit |
8cb997 |
# This program is distributed in the hope that it will be useful,
|
|
Packit |
8cb997 |
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
Packit |
8cb997 |
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
Packit |
8cb997 |
# GNU General Public License for more details.
|
|
Packit |
8cb997 |
#
|
|
Packit |
8cb997 |
# You should have received a copy of the GNU General Public License
|
|
Packit |
8cb997 |
# along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
Packit |
8cb997 |
|
|
Packit |
8cb997 |
ANSIBLE_METADATA = {
|
|
Packit |
8cb997 |
"metadata_version": "1.0",
|
|
Packit |
8cb997 |
"supported_by": "community",
|
|
Packit |
8cb997 |
"status": ["preview"],
|
|
Packit |
8cb997 |
}
|
|
Packit |
8cb997 |
|
|
Packit |
8cb997 |
|
|
Packit |
8cb997 |
DOCUMENTATION = """
|
|
Packit |
8cb997 |
---
|
|
Packit |
8cb997 |
module: ipahbacsvcgroup
|
|
Packit |
8cb997 |
short description: Manage FreeIPA hbacsvcgroups
|
|
Packit |
8cb997 |
description: Manage FreeIPA hbacsvcgroups
|
|
Packit |
8cb997 |
options:
|
|
Packit |
8cb997 |
ipaadmin_principal:
|
|
Packit |
8cb997 |
description: The admin principal
|
|
Packit |
8cb997 |
default: admin
|
|
Packit |
8cb997 |
ipaadmin_password:
|
|
Packit |
8cb997 |
description: The admin password
|
|
Packit |
8cb997 |
required: false
|
|
Packit |
8cb997 |
name:
|
|
Packit |
8cb997 |
description: The hbacsvcgroup name
|
|
Packit |
8cb997 |
required: false
|
|
Packit |
8cb997 |
aliases: ["cn"]
|
|
Packit |
8cb997 |
description:
|
|
Packit |
8cb997 |
description: The hbacsvcgroup description
|
|
Packit |
8cb997 |
required: false
|
|
Packit |
8cb997 |
hbacsvc:
|
|
Packit |
8cb997 |
description: List of hbacsvc names assigned to this hbacsvcgroup.
|
|
Packit |
8cb997 |
required: false
|
|
Packit |
8cb997 |
type: list
|
|
Packit |
8cb997 |
nomembers:
|
|
Packit |
8cb997 |
description: Suppress processing of membership attributes
|
|
Packit |
8cb997 |
required: false
|
|
Packit |
8cb997 |
type: bool
|
|
Packit |
8cb997 |
action:
|
|
Packit |
8cb997 |
description: Work on hbacsvcgroup or member level
|
|
Packit |
8cb997 |
default: hbacsvcgroup
|
|
Packit |
8cb997 |
choices: ["member", "hbacsvcgroup"]
|
|
Packit |
8cb997 |
state:
|
|
Packit |
8cb997 |
description: State to ensure
|
|
Packit |
8cb997 |
default: present
|
|
Packit |
8cb997 |
choices: ["present", "absent"]
|
|
Packit |
8cb997 |
author:
|
|
Packit |
8cb997 |
- Thomas Woerner
|
|
Packit |
8cb997 |
"""
|
|
Packit |
8cb997 |
|
|
Packit |
8cb997 |
EXAMPLES = """
|
|
Packit |
8cb997 |
# Ensure hbacsvcgroup login is present
|
|
Packit |
8cb997 |
- ipahbacsvcgroup:
|
|
Packit |
8cb997 |
ipaadmin_password: MyPassword123
|
|
Packit |
8cb997 |
name: login
|
|
Packit |
8cb997 |
hbacsvc:
|
|
Packit |
8cb997 |
- sshd
|
|
Packit |
8cb997 |
|
|
Packit |
8cb997 |
# Ensure hbacsvc sshd is present in existing login hbacsvcgroup
|
|
Packit |
8cb997 |
- ipahbacsvcgroup:
|
|
Packit |
8cb997 |
ipaadmin_password: MyPassword123
|
|
Packit |
8cb997 |
name: databases
|
|
Packit |
8cb997 |
hbacsvc:
|
|
Packit |
8cb997 |
- sshd
|
|
Packit |
8cb997 |
action: member
|
|
Packit |
8cb997 |
|
|
Packit |
8cb997 |
# Ensure hbacsvc sshd is abdsent in existing login hbacsvcgroup
|
|
Packit |
8cb997 |
- ipahbacsvcgroup:
|
|
Packit |
8cb997 |
ipaadmin_password: MyPassword123
|
|
Packit |
8cb997 |
name: databases
|
|
Packit |
8cb997 |
hbacsvc:
|
|
Packit |
8cb997 |
- sshd
|
|
Packit |
8cb997 |
action: member
|
|
Packit |
8cb997 |
state: absent
|
|
Packit |
8cb997 |
|
|
Packit |
8cb997 |
# Ensure hbacsvcgroup login is absent
|
|
Packit |
8cb997 |
- ipahbacsvcgroup:
|
|
Packit |
8cb997 |
ipaadmin_password: MyPassword123
|
|
Packit |
8cb997 |
name: login
|
|
Packit |
8cb997 |
state: absent
|
|
Packit |
8cb997 |
"""
|
|
Packit |
8cb997 |
|
|
Packit |
8cb997 |
RETURN = """
|
|
Packit |
8cb997 |
"""
|
|
Packit |
8cb997 |
|
|
Packit |
8cb997 |
from ansible.module_utils.basic import AnsibleModule
|
|
Packit |
8cb997 |
from ansible.module_utils._text import to_text
|
|
Packit |
8cb997 |
from ansible.module_utils.ansible_freeipa_module import temp_kinit, \
|
|
Packit |
8cb997 |
temp_kdestroy, valid_creds, api_connect, api_command, compare_args_ipa
|
|
Packit |
8cb997 |
|
|
Packit |
8cb997 |
|
|
Packit |
8cb997 |
def find_hbacsvcgroup(module, name):
|
|
Packit |
8cb997 |
_args = {
|
|
Packit |
8cb997 |
"all": True,
|
|
Packit |
8cb997 |
"cn": to_text(name),
|
|
Packit |
8cb997 |
}
|
|
Packit |
8cb997 |
|
|
Packit |
8cb997 |
_result = api_command(module, "hbacsvcgroup_find", to_text(name), _args)
|
|
Packit |
8cb997 |
|
|
Packit |
8cb997 |
if len(_result["result"]) > 1:
|
|
Packit |
8cb997 |
module.fail_json(
|
|
Packit |
8cb997 |
msg="There is more than one hbacsvcgroup '%s'" % (name))
|
|
Packit |
8cb997 |
elif len(_result["result"]) == 1:
|
|
Packit |
8cb997 |
return _result["result"][0]
|
|
Packit |
8cb997 |
else:
|
|
Packit |
8cb997 |
return None
|
|
Packit |
8cb997 |
|
|
Packit |
8cb997 |
|
|
Packit |
8cb997 |
def gen_args(description, nomembers):
|
|
Packit |
8cb997 |
_args = {}
|
|
Packit |
8cb997 |
if description is not None:
|
|
Packit |
8cb997 |
_args["description"] = to_text(description)
|
|
Packit |
8cb997 |
if nomembers is not None:
|
|
Packit |
8cb997 |
_args["nomembers"] = nomembers
|
|
Packit |
8cb997 |
|
|
Packit |
8cb997 |
return _args
|
|
Packit |
8cb997 |
|
|
Packit |
8cb997 |
|
|
Packit |
8cb997 |
def gen_member_args(hbacsvc):
|
|
Packit |
8cb997 |
_args = {}
|
|
Packit |
8cb997 |
if hbacsvc is not None:
|
|
Packit |
8cb997 |
_args["member_hbacsvc"] = [to_text(svc) for svc in hbacsvc]
|
|
Packit |
8cb997 |
|
|
Packit |
8cb997 |
return _args
|
|
Packit |
8cb997 |
|
|
Packit |
8cb997 |
|
|
Packit |
8cb997 |
def main():
|
|
Packit |
8cb997 |
ansible_module = AnsibleModule(
|
|
Packit |
8cb997 |
argument_spec=dict(
|
|
Packit |
8cb997 |
# general
|
|
Packit |
8cb997 |
ipaadmin_principal=dict(type="str", default="admin"),
|
|
Packit |
8cb997 |
ipaadmin_password=dict(type="str", required=False, no_log=True),
|
|
Packit |
8cb997 |
|
|
Packit |
8cb997 |
name=dict(type="list", aliases=["cn"], default=None,
|
|
Packit |
8cb997 |
required=True),
|
|
Packit |
8cb997 |
# present
|
|
Packit |
8cb997 |
description=dict(type="str", default=None),
|
|
Packit |
8cb997 |
nomembers=dict(required=False, type='bool', default=None),
|
|
Packit |
8cb997 |
hbacsvc=dict(required=False, type='list', default=None),
|
|
Packit |
8cb997 |
action=dict(type="str", default="hbacsvcgroup",
|
|
Packit |
8cb997 |
choices=["member", "hbacsvcgroup"]),
|
|
Packit |
8cb997 |
# state
|
|
Packit |
8cb997 |
state=dict(type="str", default="present",
|
|
Packit |
8cb997 |
choices=["present", "absent"]),
|
|
Packit |
8cb997 |
),
|
|
Packit |
8cb997 |
supports_check_mode=True,
|
|
Packit |
8cb997 |
)
|
|
Packit |
8cb997 |
|
|
Packit |
8cb997 |
ansible_module._ansible_debug = True
|
|
Packit |
8cb997 |
|
|
Packit |
8cb997 |
# Get parameters
|
|
Packit |
8cb997 |
|
|
Packit |
8cb997 |
# general
|
|
Packit |
8cb997 |
ipaadmin_principal = ansible_module.params.get("ipaadmin_principal")
|
|
Packit |
8cb997 |
ipaadmin_password = ansible_module.params.get("ipaadmin_password")
|
|
Packit |
8cb997 |
names = ansible_module.params.get("name")
|
|
Packit |
8cb997 |
|
|
Packit |
8cb997 |
# present
|
|
Packit |
8cb997 |
description = ansible_module.params.get("description")
|
|
Packit |
8cb997 |
nomembers = ansible_module.params.get("nomembers")
|
|
Packit |
8cb997 |
hbacsvc = ansible_module.params.get("hbacsvc")
|
|
Packit |
8cb997 |
action = ansible_module.params.get("action")
|
|
Packit |
8cb997 |
# state
|
|
Packit |
8cb997 |
state = ansible_module.params.get("state")
|
|
Packit |
8cb997 |
|
|
Packit |
8cb997 |
# Check parameters
|
|
Packit |
8cb997 |
|
|
Packit |
8cb997 |
if state == "present":
|
|
Packit |
8cb997 |
if len(names) != 1:
|
|
Packit |
8cb997 |
ansible_module.fail_json(
|
|
Packit |
8cb997 |
msg="Only one hbacsvcgroup can be added at a time.")
|
|
Packit |
8cb997 |
if action == "member":
|
|
Packit |
8cb997 |
invalid = ["description", "nomembers"]
|
|
Packit |
8cb997 |
for x in invalid:
|
|
Packit |
8cb997 |
if vars()[x] is not None:
|
|
Packit |
8cb997 |
ansible_module.fail_json(
|
|
Packit |
8cb997 |
msg="Argument '%s' can not be used with action "
|
|
Packit |
8cb997 |
"'%s'" % (x, action))
|
|
Packit |
8cb997 |
|
|
Packit |
8cb997 |
if state == "absent":
|
|
Packit |
8cb997 |
if len(names) < 1:
|
|
Packit |
8cb997 |
ansible_module.fail_json(
|
|
Packit |
8cb997 |
msg="No name given.")
|
|
Packit |
8cb997 |
invalid = ["description", "nomembers"]
|
|
Packit |
8cb997 |
if action == "hbacsvcgroup":
|
|
Packit |
8cb997 |
invalid.extend(["hbacsvc"])
|
|
Packit |
8cb997 |
for x in invalid:
|
|
Packit |
8cb997 |
if vars()[x] is not None:
|
|
Packit |
8cb997 |
ansible_module.fail_json(
|
|
Packit |
8cb997 |
msg="Argument '%s' can not be used with state '%s'" %
|
|
Packit |
8cb997 |
(x, state))
|
|
Packit |
8cb997 |
|
|
Packit |
8cb997 |
# Init
|
|
Packit |
8cb997 |
|
|
Packit |
8cb997 |
changed = False
|
|
Packit |
8cb997 |
exit_args = {}
|
|
Packit |
8cb997 |
ccache_dir = None
|
|
Packit |
8cb997 |
ccache_name = None
|
|
Packit |
8cb997 |
try:
|
|
Packit |
8cb997 |
if not valid_creds(ansible_module, ipaadmin_principal):
|
|
Packit |
8cb997 |
ccache_dir, ccache_name = temp_kinit(ipaadmin_principal,
|
|
Packit |
8cb997 |
ipaadmin_password)
|
|
Packit |
8cb997 |
api_connect()
|
|
Packit |
8cb997 |
|
|
Packit |
8cb997 |
commands = []
|
|
Packit |
8cb997 |
|
|
Packit |
8cb997 |
for name in names:
|
|
Packit |
8cb997 |
# Make sure hbacsvcgroup exists
|
|
Packit |
8cb997 |
res_find = find_hbacsvcgroup(ansible_module, name)
|
|
Packit |
8cb997 |
|
|
Packit |
8cb997 |
# Create command
|
|
Packit |
8cb997 |
if state == "present":
|
|
Packit |
8cb997 |
# Generate args
|
|
Packit |
8cb997 |
args = gen_args(description, nomembers)
|
|
Packit |
8cb997 |
|
|
Packit |
8cb997 |
if action == "hbacsvcgroup":
|
|
Packit |
8cb997 |
# Found the hbacsvcgroup
|
|
Packit |
8cb997 |
if res_find is not None:
|
|
Packit |
8cb997 |
# For all settings is args, check if there are
|
|
Packit |
8cb997 |
# different settings in the find result.
|
|
Packit |
8cb997 |
# If yes: modify
|
|
Packit |
8cb997 |
if not compare_args_ipa(ansible_module, args,
|
|
Packit |
8cb997 |
res_find):
|
|
Packit |
8cb997 |
commands.append([name, "hbacsvcgroup_mod", args])
|
|
Packit |
8cb997 |
else:
|
|
Packit |
8cb997 |
commands.append([name, "hbacsvcgroup_add", args])
|
|
Packit |
8cb997 |
# Set res_find to empty dict for next step
|
|
Packit |
8cb997 |
res_find = {}
|
|
Packit |
8cb997 |
|
|
Packit |
8cb997 |
member_args = gen_member_args(hbacsvc)
|
|
Packit |
8cb997 |
if not compare_args_ipa(ansible_module, member_args,
|
|
Packit |
8cb997 |
res_find):
|
|
Packit |
8cb997 |
# Generate addition and removal lists
|
|
Packit |
8cb997 |
hbacsvc_add = list(
|
|
Packit |
8cb997 |
set(hbacsvc or []) -
|
|
Packit |
8cb997 |
set(res_find.get("member_hbacsvc", [])))
|
|
Packit |
8cb997 |
hbacsvc_del = list(
|
|
Packit |
8cb997 |
set(res_find.get("member_hbacsvc", [])) -
|
|
Packit |
8cb997 |
set(hbacsvc or []))
|
|
Packit |
8cb997 |
|
|
Packit |
8cb997 |
# Add members
|
|
Packit |
8cb997 |
if len(hbacsvc_add) > 0:
|
|
Packit |
8cb997 |
commands.append([name, "hbacsvcgroup_add_member",
|
|
Packit |
8cb997 |
{
|
|
Packit |
8cb997 |
"hbacsvc":
|
|
Packit |
8cb997 |
[to_text(svc)
|
|
Packit |
8cb997 |
for svc in hbacsvc_add],
|
|
Packit |
8cb997 |
}])
|
|
Packit |
8cb997 |
# Remove members
|
|
Packit |
8cb997 |
if len(hbacsvc_del) > 0:
|
|
Packit |
8cb997 |
commands.append([name,
|
|
Packit |
8cb997 |
"hbacsvcgroup_remove_member",
|
|
Packit |
8cb997 |
{
|
|
Packit |
8cb997 |
"hbacsvc":
|
|
Packit |
8cb997 |
[to_text(svc)
|
|
Packit |
8cb997 |
for svc in hbacsvc_del],
|
|
Packit |
8cb997 |
}])
|
|
Packit |
8cb997 |
elif action == "member":
|
|
Packit |
8cb997 |
if res_find is None:
|
|
Packit |
8cb997 |
ansible_module.fail_json(
|
|
Packit |
8cb997 |
msg="No hbacsvcgroup '%s'" % name)
|
|
Packit |
8cb997 |
|
|
Packit |
8cb997 |
# Ensure members are present
|
|
Packit |
8cb997 |
commands.append([name, "hbacsvcgroup_add_member",
|
|
Packit |
8cb997 |
{
|
|
Packit |
8cb997 |
"hbacsvc": [to_text(svc)
|
|
Packit |
8cb997 |
for svc in hbacsvc],
|
|
Packit |
8cb997 |
}])
|
|
Packit |
8cb997 |
elif state == "absent":
|
|
Packit |
8cb997 |
if action == "hbacsvcgroup":
|
|
Packit |
8cb997 |
if res_find is not None:
|
|
Packit |
8cb997 |
commands.append([name, "hbacsvcgroup_del", {}])
|
|
Packit |
8cb997 |
|
|
Packit |
8cb997 |
elif action == "member":
|
|
Packit |
8cb997 |
if res_find is None:
|
|
Packit |
8cb997 |
ansible_module.fail_json(
|
|
Packit |
8cb997 |
msg="No hbacsvcgroup '%s'" % name)
|
|
Packit |
8cb997 |
|
|
Packit |
8cb997 |
# Ensure members are absent
|
|
Packit |
8cb997 |
commands.append([name, "hbacsvcgroup_remove_member",
|
|
Packit |
8cb997 |
{
|
|
Packit |
8cb997 |
"hbacsvc": [to_text(svc)
|
|
Packit |
8cb997 |
for svc in hbacsvc],
|
|
Packit |
8cb997 |
}])
|
|
Packit |
8cb997 |
else:
|
|
Packit |
8cb997 |
ansible_module.fail_json(msg="Unkown state '%s'" % state)
|
|
Packit |
8cb997 |
|
|
Packit |
8cb997 |
# Execute commands
|
|
Packit |
8cb997 |
errors = []
|
|
Packit |
8cb997 |
for name, command, args in commands:
|
|
Packit |
8cb997 |
try:
|
|
Packit |
8cb997 |
result = api_command(ansible_module, command, to_text(name),
|
|
Packit |
8cb997 |
args)
|
|
Packit |
8cb997 |
if "completed" in result:
|
|
Packit |
8cb997 |
if result["completed"] > 0:
|
|
Packit |
8cb997 |
changed = True
|
|
Packit |
8cb997 |
else:
|
|
Packit |
8cb997 |
changed = True
|
|
Packit |
8cb997 |
except Exception as e:
|
|
Packit |
8cb997 |
ansible_module.fail_json(msg="%s: %s: %s" % (command, name,
|
|
Packit |
8cb997 |
str(e)))
|
|
Packit |
8cb997 |
# Get all errors
|
|
Packit |
8cb997 |
# All "already a member" and "not a member" failures in the
|
|
Packit |
8cb997 |
# result are ignored. All others are reported.
|
|
Packit |
8cb997 |
if "failed" in result and "member" in result["failed"]:
|
|
Packit |
8cb997 |
failed = result["failed"]["member"]
|
|
Packit |
8cb997 |
for member_type in failed:
|
|
Packit |
8cb997 |
for member, failure in failed[member_type]:
|
|
Packit |
8cb997 |
if "already a member" not in failure \
|
|
Packit |
8cb997 |
and "not a member" not in failure:
|
|
Packit |
8cb997 |
errors.append("%s: %s %s: %s" % (
|
|
Packit |
8cb997 |
command, member_type, member, failure))
|
|
Packit |
8cb997 |
if len(errors) > 0:
|
|
Packit |
8cb997 |
ansible_module.fail_json(msg=", ".join(errors))
|
|
Packit |
8cb997 |
|
|
Packit |
8cb997 |
except Exception as e:
|
|
Packit |
8cb997 |
ansible_module.fail_json(msg=str(e))
|
|
Packit |
8cb997 |
|
|
Packit |
8cb997 |
finally:
|
|
Packit |
8cb997 |
temp_kdestroy(ccache_dir, ccache_name)
|
|
Packit |
8cb997 |
|
|
Packit |
8cb997 |
# Done
|
|
Packit |
8cb997 |
|
|
Packit |
8cb997 |
ansible_module.exit_json(changed=changed, **exit_args)
|
|
Packit |
8cb997 |
|
|
Packit |
8cb997 |
|
|
Packit |
8cb997 |
if __name__ == "__main__":
|
|
Packit |
8cb997 |
main()
|