mirror of
https://github.com/freeipa/ansible-freeipa.git
synced 2026-03-26 21:33:05 +00:00
457050c6ac
Because of a missing check member attributes (for use with action: member) are cleared when a non-member attribute is changed. The fix simply adds a check for None (parameter not set) to gen_add_del_lists in ansible_freeipa_module to make sure that the parameter is only changed if it should be changed. All places where the add and removal lists have been generated manually have been changed to also use gen_add_del_lists. Resolves: #252 (The "Manager" attribute is removed when updating any user attribute)
355 lines
12 KiB
Python
355 lines
12 KiB
Python
#!/usr/bin/python
|
|
# -*- coding: utf-8 -*-
|
|
|
|
# Authors:
|
|
# Rafael Guterres Jeffman <rjeffman@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/>.
|
|
|
|
ANSIBLE_METADATA = {
|
|
"metadata_version": "1.0",
|
|
"supported_by": "community",
|
|
"status": ["preview"],
|
|
}
|
|
|
|
|
|
DOCUMENTATION = """
|
|
---
|
|
module: ipasudocmdgroup
|
|
short description: Manage FreeIPA sudocmd groups
|
|
description: Manage FreeIPA sudocmd groups
|
|
options:
|
|
ipaadmin_principal:
|
|
description: The admin principal
|
|
default: admin
|
|
ipaadmin_password:
|
|
description: The admin password
|
|
required: false
|
|
name:
|
|
description: The sudocmodgroup name
|
|
required: false
|
|
aliases: ["cn"]
|
|
description:
|
|
description: The sudocmdgroup description
|
|
required: false
|
|
nomembers:
|
|
description: Suppress processing of membership attributes
|
|
required: false
|
|
type: bool
|
|
sudocmdgroup:
|
|
description: List of sudocmdgroup names assigned to this sudocmdgroup.
|
|
required: false
|
|
type: list
|
|
sudocmd:
|
|
description: List of sudocmds assigned to this sudocmdgroup.
|
|
required: false
|
|
type: list
|
|
action:
|
|
description: Work on sudocmdgroup or member level
|
|
default: hostgroup
|
|
choices: ["member", "sudocmdgroup"]
|
|
state:
|
|
description: State to ensure
|
|
default: present
|
|
choices: ["present", "absent"]
|
|
author:
|
|
- Rafael Guterres Jeffman
|
|
"""
|
|
|
|
EXAMPLES = """
|
|
# Ensure sudocmd-group 'network' is present
|
|
- ipasudocmdgroup:
|
|
ipaadmin_password: SomeADMINpassword
|
|
name: network
|
|
state: present
|
|
|
|
# Ensure sudocmdgroup and sudocmd are present in 'network' sudocmdgroup
|
|
- ipasudocmdgroup:
|
|
ipaadmin_password: SomeADMINpassword
|
|
name: network
|
|
sudocmd:
|
|
- /usr/sbin/ifconfig
|
|
- /usr/sbin/iwlist
|
|
action: member
|
|
|
|
# Ensure sudocmdgroup and sudocmd are absent in 'network' sudocmdgroup
|
|
- ipasudocmdgroup:
|
|
ipaadmin_password: SomeADMINpassword
|
|
name: network
|
|
sudocmd:
|
|
- /usr/sbin/ifconfig
|
|
- /usr/sbin/iwlist
|
|
action: member
|
|
state: absent
|
|
|
|
# Ensure sudocmd-group 'network' is absent
|
|
- ipasudocmdgroup:
|
|
ipaadmin_password: SomeADMINpassword
|
|
name: network
|
|
action: member
|
|
state: absent
|
|
"""
|
|
|
|
RETURN = """
|
|
"""
|
|
|
|
from ansible.module_utils.basic import AnsibleModule
|
|
from ansible.module_utils._text import to_text
|
|
from ansible.module_utils.ansible_freeipa_module import temp_kinit, \
|
|
temp_kdestroy, valid_creds, api_connect, api_command, compare_args_ipa, \
|
|
gen_add_del_lists
|
|
|
|
|
|
def find_sudocmdgroup(module, name):
|
|
_args = {
|
|
"all": True,
|
|
"cn": to_text(name),
|
|
}
|
|
|
|
_result = api_command(module, "sudocmdgroup_find", to_text(name), _args)
|
|
|
|
if len(_result["result"]) > 1:
|
|
module.fail_json(
|
|
msg="There is more than one sudocmdgroup '%s'" % (name))
|
|
elif len(_result["result"]) == 1:
|
|
return _result["result"][0]
|
|
else:
|
|
return None
|
|
|
|
|
|
def gen_args(description, nomembers):
|
|
_args = {}
|
|
if description is not None:
|
|
_args["description"] = to_text(description)
|
|
if nomembers is not None:
|
|
_args["nomembers"] = nomembers
|
|
|
|
return _args
|
|
|
|
|
|
def gen_member_args(sudocmdgroup):
|
|
_args = {}
|
|
if sudocmdgroup is not None:
|
|
_args["member_sudocmdgroup"] = sudocmdgroup
|
|
|
|
return _args
|
|
|
|
|
|
def main():
|
|
ansible_module = AnsibleModule(
|
|
argument_spec=dict(
|
|
# general
|
|
ipaadmin_principal=dict(type="str", default="admin"),
|
|
ipaadmin_password=dict(type="str", required=False, no_log=True),
|
|
|
|
name=dict(type="list", aliases=["cn"], default=None,
|
|
required=True),
|
|
# present
|
|
description=dict(type="str", default=None),
|
|
nomembers=dict(required=False, type='bool', default=None),
|
|
sudocmdgroup=dict(required=False, type='list', default=None),
|
|
sudocmd=dict(required=False, type='list', default=None),
|
|
action=dict(type="str", default="sudocmdgroup",
|
|
choices=["member", "sudocmdgroup"]),
|
|
# state
|
|
state=dict(type="str", default="present",
|
|
choices=["present", "absent"]),
|
|
),
|
|
supports_check_mode=True,
|
|
)
|
|
|
|
ansible_module._ansible_debug = True
|
|
|
|
# Get parameters
|
|
|
|
# general
|
|
ipaadmin_principal = ansible_module.params.get("ipaadmin_principal")
|
|
ipaadmin_password = ansible_module.params.get("ipaadmin_password")
|
|
names = ansible_module.params.get("name")
|
|
|
|
# present
|
|
description = ansible_module.params.get("description")
|
|
nomembers = ansible_module.params.get("nomembers")
|
|
sudocmdgroup = ansible_module.params.get("sudocmdgroup")
|
|
sudocmd = ansible_module.params.get("sudocmd")
|
|
action = ansible_module.params.get("action")
|
|
# state
|
|
state = ansible_module.params.get("state")
|
|
|
|
# Check parameters
|
|
|
|
if state == "present":
|
|
if len(names) != 1:
|
|
ansible_module.fail_json(
|
|
msg="Only one sudocmdgroup can be added at a time.")
|
|
if action == "member":
|
|
invalid = ["description", "nomembers"]
|
|
for x in invalid:
|
|
if vars()[x] is not None:
|
|
ansible_module.fail_json(
|
|
msg="Argument '%s' can not be used with action "
|
|
"'%s'" % (x, action))
|
|
|
|
if state == "absent":
|
|
if len(names) < 1:
|
|
ansible_module.fail_json(
|
|
msg="No name given.")
|
|
invalid = ["description", "nomembers"]
|
|
if action == "sudocmdgroup":
|
|
invalid.extend(["sudocmd"])
|
|
for x in invalid:
|
|
if vars()[x] is not None:
|
|
ansible_module.fail_json(
|
|
msg="Argument '%s' can not be used with state '%s'" %
|
|
(x, state))
|
|
|
|
# Init
|
|
|
|
changed = False
|
|
exit_args = {}
|
|
ccache_dir = None
|
|
ccache_name = None
|
|
try:
|
|
if not valid_creds(ansible_module, ipaadmin_principal):
|
|
ccache_dir, ccache_name = temp_kinit(ipaadmin_principal,
|
|
ipaadmin_password)
|
|
api_connect()
|
|
|
|
commands = []
|
|
|
|
for name in names:
|
|
# Make sure hostgroup exists
|
|
res_find = find_sudocmdgroup(ansible_module, name)
|
|
|
|
# Create command
|
|
if state == "present":
|
|
# Generate args
|
|
args = gen_args(description, nomembers)
|
|
|
|
if action == "sudocmdgroup":
|
|
# Found the hostgroup
|
|
if res_find is not None:
|
|
# For all settings is args, check if there are
|
|
# different settings in the find result.
|
|
# If yes: modify
|
|
if not compare_args_ipa(ansible_module, args,
|
|
res_find):
|
|
commands.append([name, "sudocmdgroup_mod", args])
|
|
else:
|
|
commands.append([name, "sudocmdgroup_add", args])
|
|
# Set res_find to empty dict for next step
|
|
res_find = {}
|
|
|
|
member_args = gen_member_args(sudocmd)
|
|
if not compare_args_ipa(ansible_module, member_args,
|
|
res_find):
|
|
# Generate addition and removal lists
|
|
sudocmdgroup_add, sudocmdgroup_del = \
|
|
gen_add_del_lists(
|
|
sudocmdgroup,
|
|
res_find.get("member_sudocmdgroup"))
|
|
|
|
# Add members
|
|
if len(sudocmdgroup_add) > 0:
|
|
commands.append([name, "sudocmdgroup_add_member",
|
|
{
|
|
"sudocmd": [to_text(c)
|
|
for c in
|
|
sudocmdgroup_add]
|
|
}
|
|
])
|
|
# Remove members
|
|
if len(sudocmdgroup_del) > 0:
|
|
commands.append([name,
|
|
"sudocmdgroup_remove_member",
|
|
{
|
|
"sudocmd": [to_text(c)
|
|
for c in
|
|
sudocmdgroup_del]
|
|
}
|
|
])
|
|
elif action == "member":
|
|
if res_find is None:
|
|
ansible_module.fail_json(
|
|
msg="No sudocmdgroup '%s'" % name)
|
|
|
|
# Ensure members are present
|
|
commands.append([name, "sudocmdgroup_add_member",
|
|
{"sudocmd": [to_text(c) for c in sudocmd]}
|
|
])
|
|
elif state == "absent":
|
|
if action == "sudocmdgroup":
|
|
if res_find is not None:
|
|
commands.append([name, "sudocmdgroup_del", {}])
|
|
|
|
elif action == "member":
|
|
if res_find is None:
|
|
ansible_module.fail_json(
|
|
msg="No sudocmdgroup '%s'" % name)
|
|
|
|
# Ensure members are absent
|
|
commands.append([name, "sudocmdgroup_remove_member",
|
|
{"sudocmd": [to_text(c) for c in sudocmd]}
|
|
])
|
|
else:
|
|
ansible_module.fail_json(msg="Unkown state '%s'" % state)
|
|
|
|
# Execute commands
|
|
for name, command, args in commands:
|
|
try:
|
|
result = api_command(ansible_module, command, to_text(name),
|
|
args)
|
|
if action == "member":
|
|
if "completed" in result and result["completed"] > 0:
|
|
changed = True
|
|
else:
|
|
if command == "sudocmdgroup_del":
|
|
changed |= "Deleted" in result['summary']
|
|
elif command == "sudocmdgroup_add":
|
|
changed |= "Added" in result['summary']
|
|
except Exception as e:
|
|
ansible_module.fail_json(msg="%s: %s: %s" % (command, name,
|
|
str(e)))
|
|
# Get all errors
|
|
# All "already a member" and "not a member" failures in the
|
|
# result are ignored. All others are reported.
|
|
errors = []
|
|
if "failed" in result and "member" in result["failed"]:
|
|
failed = result["failed"]["member"]
|
|
for member_type in failed:
|
|
for member, failure in failed[member_type]:
|
|
if "already a member" not in failure \
|
|
and "not a member" not in failure:
|
|
errors.append("%s: %s %s: %s" % (
|
|
command, member_type, member, failure))
|
|
if len(errors) > 0:
|
|
ansible_module.fail_json(msg=", ".join(errors))
|
|
|
|
except Exception as e:
|
|
ansible_module.fail_json(msg=str(e))
|
|
|
|
finally:
|
|
temp_kdestroy(ccache_dir, ccache_name)
|
|
|
|
# Done
|
|
|
|
ansible_module.exit_json(changed=changed, **exit_args)
|
|
|
|
|
|
if __name__ == "__main__":
|
|
main()
|