#!/usr/bin/python # -*- coding: utf-8 -*- # Copyright (c) 2017, Ansible Project # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = r''' --- module: ipa_hostgroup author: Thomas Krahn (@Nosmoht) short_description: Manage FreeIPA host-group description: - Add, modify and delete an IPA host-group using IPA API. attributes: check_mode: support: full diff_mode: support: none options: append: description: - If C(true), add the listed I(host) to the I(hostgroup). - If C(false), only the listed I(host) will be in I(hostgroup), removing any other hosts. default: false type: bool version_added: 6.6.0 cn: description: - Name of host-group. - Can not be changed as it is the unique identifier. required: true aliases: ["name"] type: str description: description: - Description. type: str host: description: - List of hosts that belong to the host-group. - If an empty list is passed all hosts will be removed from the group. - If option is omitted hosts will not be checked or changed. - If option is passed all assigned hosts that are not passed will be unassigned from the group. type: list elements: str hostgroup: description: - List of host-groups than belong to that host-group. - If an empty list is passed all host-groups will be removed from the group. - If option is omitted host-groups will not be checked or changed. - If option is passed all assigned hostgroups that are not passed will be unassigned from the group. type: list elements: str state: description: - State to ensure. default: "present" choices: ["absent", "disabled", "enabled", "present"] type: str extends_documentation_fragment: - community.general.ipa.documentation - community.general.attributes ''' EXAMPLES = r''' - name: Ensure host-group databases is present community.general.ipa_hostgroup: name: databases state: present host: - db.example.com hostgroup: - mysql-server - oracle-server ipa_host: ipa.example.com ipa_user: admin ipa_pass: topsecret - name: Ensure host-group databases is absent community.general.ipa_hostgroup: name: databases state: absent ipa_host: ipa.example.com ipa_user: admin ipa_pass: topsecret ''' RETURN = r''' hostgroup: description: Hostgroup as returned by IPA API. returned: always type: dict ''' import traceback from ansible.module_utils.basic import AnsibleModule from ansible_collections.community.general.plugins.module_utils.ipa import IPAClient, ipa_argument_spec from ansible.module_utils.common.text.converters import to_native class HostGroupIPAClient(IPAClient): def __init__(self, module, host, port, protocol): super(HostGroupIPAClient, self).__init__(module, host, port, protocol) def hostgroup_find(self, name): return self._post_json(method='hostgroup_find', name=None, item={'all': True, 'cn': name}) def hostgroup_add(self, name, item): return self._post_json(method='hostgroup_add', name=name, item=item) def hostgroup_mod(self, name, item): return self._post_json(method='hostgroup_mod', name=name, item=item) def hostgroup_del(self, name): return self._post_json(method='hostgroup_del', name=name) def hostgroup_add_member(self, name, item): return self._post_json(method='hostgroup_add_member', name=name, item=item) def hostgroup_add_host(self, name, item): return self.hostgroup_add_member(name=name, item={'host': item}) def hostgroup_add_hostgroup(self, name, item): return self.hostgroup_add_member(name=name, item={'hostgroup': item}) def hostgroup_remove_member(self, name, item): return self._post_json(method='hostgroup_remove_member', name=name, item=item) def hostgroup_remove_host(self, name, item): return self.hostgroup_remove_member(name=name, item={'host': item}) def hostgroup_remove_hostgroup(self, name, item): return self.hostgroup_remove_member(name=name, item={'hostgroup': item}) def get_hostgroup_dict(description=None): data = {} if description is not None: data['description'] = description return data def get_hostgroup_diff(client, ipa_hostgroup, module_hostgroup): return client.get_diff(ipa_data=ipa_hostgroup, module_data=module_hostgroup) def ensure(module, client): name = module.params['cn'] state = module.params['state'] host = module.params['host'] hostgroup = module.params['hostgroup'] append = module.params['append'] ipa_hostgroup = client.hostgroup_find(name=name) module_hostgroup = get_hostgroup_dict(description=module.params['description']) changed = False if state == 'present': if not ipa_hostgroup: changed = True if not module.check_mode: ipa_hostgroup = client.hostgroup_add(name=name, item=module_hostgroup) else: diff = get_hostgroup_diff(client, ipa_hostgroup, module_hostgroup) if len(diff) > 0: changed = True if not module.check_mode: data = {} for key in diff: data[key] = module_hostgroup.get(key) client.hostgroup_mod(name=name, item=data) if host is not None: changed = client.modify_if_diff(name, ipa_hostgroup.get('member_host', []), [item.lower() for item in host], client.hostgroup_add_host, client.hostgroup_remove_host, append=append) or changed if hostgroup is not None: changed = client.modify_if_diff(name, ipa_hostgroup.get('member_hostgroup', []), [item.lower() for item in hostgroup], client.hostgroup_add_hostgroup, client.hostgroup_remove_hostgroup, append=append) or changed else: if ipa_hostgroup: changed = True if not module.check_mode: client.hostgroup_del(name=name) return changed, client.hostgroup_find(name=name) def main(): argument_spec = ipa_argument_spec() argument_spec.update(cn=dict(type='str', required=True, aliases=['name']), description=dict(type='str'), host=dict(type='list', elements='str'), hostgroup=dict(type='list', elements='str'), state=dict(type='str', default='present', choices=['present', 'absent', 'enabled', 'disabled']), append=dict(type='bool', default=False)) module = AnsibleModule(argument_spec=argument_spec, supports_check_mode=True) client = HostGroupIPAClient(module=module, host=module.params['ipa_host'], port=module.params['ipa_port'], protocol=module.params['ipa_prot']) try: client.login(username=module.params['ipa_user'], password=module.params['ipa_pass']) changed, hostgroup = ensure(module, client) module.exit_json(changed=changed, hostgroup=hostgroup) except Exception as e: module.fail_json(msg=to_native(e), exception=traceback.format_exc()) if __name__ == '__main__': main()