290 lines
9.5 KiB
Python
290 lines
9.5 KiB
Python
#!/usr/bin/python
|
|
# -*- coding: utf-8 -*-
|
|
# This file is part of Ansible
|
|
#
|
|
# Ansible 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.
|
|
#
|
|
# Ansible 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 Ansible. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
ANSIBLE_METADATA = {'metadata_version': '1.0',
|
|
'status': ['preview'],
|
|
'supported_by': 'community'}
|
|
|
|
|
|
DOCUMENTATION = '''
|
|
---
|
|
module: ipa_group
|
|
author: Thomas Krahn (@Nosmoht)
|
|
short_description: Manage FreeIPA group
|
|
description:
|
|
- Add, modify and delete group within IPA server
|
|
options:
|
|
cn:
|
|
description:
|
|
- Canonical name.
|
|
- Can not be changed as it is the unique identifier.
|
|
required: true
|
|
aliases: ['name']
|
|
external:
|
|
description:
|
|
- Allow adding external non-IPA members from trusted domains.
|
|
required: false
|
|
gidnumber:
|
|
description:
|
|
- GID (use this option to set it manually).
|
|
required: false
|
|
group:
|
|
description:
|
|
- List of group names assigned to this group.
|
|
- If an empty list is passed all groups will be removed from this group.
|
|
- If option is omitted assigned groups will not be checked or changed.
|
|
- Groups that are already assigned but not passed will be removed.
|
|
nonposix:
|
|
description:
|
|
- Create as a non-POSIX group.
|
|
required: false
|
|
user:
|
|
description:
|
|
- List of user names assigned to this group.
|
|
- If an empty list is passed all users will be removed from this group.
|
|
- If option is omitted assigned users will not be checked or changed.
|
|
- Users that are already assigned but not passed will be removed.
|
|
state:
|
|
description:
|
|
- State to ensure
|
|
required: false
|
|
default: "present"
|
|
choices: ["present", "absent"]
|
|
ipa_port:
|
|
description: Port of IPA server
|
|
required: false
|
|
default: 443
|
|
ipa_host:
|
|
description: IP or hostname of IPA server
|
|
required: false
|
|
default: "ipa.example.com"
|
|
ipa_user:
|
|
description: Administrative account used on IPA server
|
|
required: false
|
|
default: "admin"
|
|
ipa_pass:
|
|
description: Password of administrative user
|
|
required: true
|
|
ipa_prot:
|
|
description: Protocol used by IPA server
|
|
required: false
|
|
default: "https"
|
|
choices: ["http", "https"]
|
|
validate_certs:
|
|
description:
|
|
- This only applies if C(ipa_prot) is I(https).
|
|
- If set to C(no), the SSL certificates will not be validated.
|
|
- This should only set to C(no) used on personally controlled sites using self-signed certificates.
|
|
required: false
|
|
default: true
|
|
version_added: "2.3"
|
|
'''
|
|
|
|
EXAMPLES = '''
|
|
# Ensure group is present
|
|
- ipa_group:
|
|
name: oinstall
|
|
gidnumber: 54321
|
|
state: present
|
|
ipa_host: ipa.example.com
|
|
ipa_user: admin
|
|
ipa_pass: topsecret
|
|
|
|
# Ensure that groups sysops and appops are assigned to ops but no other group
|
|
- ipa_group:
|
|
name: ops
|
|
group:
|
|
- sysops
|
|
- appops
|
|
ipa_host: ipa.example.com
|
|
ipa_user: admin
|
|
ipa_pass: topsecret
|
|
|
|
# Ensure that users linus and larry are assign to the group, but no other user
|
|
- ipa_group:
|
|
name: sysops
|
|
user:
|
|
- linus
|
|
- larry
|
|
ipa_host: ipa.example.com
|
|
ipa_user: admin
|
|
ipa_pass: topsecret
|
|
|
|
# Ensure group is absent
|
|
- ipa_group:
|
|
name: sysops
|
|
state: absent
|
|
ipa_host: ipa.example.com
|
|
ipa_user: admin
|
|
ipa_pass: topsecret
|
|
'''
|
|
|
|
RETURN = '''
|
|
group:
|
|
description: Group as returned by IPA API
|
|
returned: always
|
|
type: dict
|
|
'''
|
|
|
|
from ansible.module_utils.basic import AnsibleModule
|
|
from ansible.module_utils.pycompat24 import get_exception
|
|
from ansible.module_utils.ipa import IPAClient
|
|
|
|
|
|
class GroupIPAClient(IPAClient):
|
|
def __init__(self, module, host, port, protocol):
|
|
super(GroupIPAClient, self).__init__(module, host, port, protocol)
|
|
|
|
def group_find(self, name):
|
|
return self._post_json(method='group_find', name=None, item={'all': True, 'cn': name})
|
|
|
|
def group_add(self, name, item):
|
|
return self._post_json(method='group_add', name=name, item=item)
|
|
|
|
def group_mod(self, name, item):
|
|
return self._post_json(method='group_mod', name=name, item=item)
|
|
|
|
def group_del(self, name):
|
|
return self._post_json(method='group_del', name=name)
|
|
|
|
def group_add_member(self, name, item):
|
|
return self._post_json(method='group_add_member', name=name, item=item)
|
|
|
|
def group_add_member_group(self, name, item):
|
|
return self.group_add_member(name=name, item={'group': item})
|
|
|
|
def group_add_member_user(self, name, item):
|
|
return self.group_add_member(name=name, item={'user': item})
|
|
|
|
def group_remove_member(self, name, item):
|
|
return self._post_json(method='group_remove_member', name=name, item=item)
|
|
|
|
def group_remove_member_group(self, name, item):
|
|
return self.group_remove_member(name=name, item={'group': item})
|
|
|
|
def group_remove_member_user(self, name, item):
|
|
return self.group_remove_member(name=name, item={'user': item})
|
|
|
|
|
|
def get_group_dict(description=None, external=None, gid=None, nonposix=None):
|
|
group = {}
|
|
if description is not None:
|
|
group['description'] = description
|
|
if external is not None:
|
|
group['external'] = external
|
|
if gid is not None:
|
|
group['gidnumber'] = gid
|
|
if nonposix is not None:
|
|
group['nonposix'] = nonposix
|
|
return group
|
|
|
|
|
|
def get_group_diff(client, ipa_group, module_group):
|
|
data = []
|
|
# With group_add attribute nonposix is passed, whereas with group_mod only posix can be passed.
|
|
if 'nonposix' in module_group:
|
|
# Only non-posix groups can be changed to posix
|
|
if not module_group['nonposix'] and ipa_group.get('nonposix'):
|
|
module_group['posix'] = True
|
|
del module_group['nonposix']
|
|
|
|
return client.get_diff(ipa_data=ipa_group, module_data=module_group)
|
|
|
|
|
|
def ensure(module, client):
|
|
state = module.params['state']
|
|
name = module.params['name']
|
|
group = module.params['group']
|
|
user = module.params['user']
|
|
|
|
module_group = get_group_dict(description=module.params['description'], external=module.params['external'],
|
|
gid=module.params['gidnumber'], nonposix=module.params['nonposix'])
|
|
ipa_group = client.group_find(name=name)
|
|
|
|
changed = False
|
|
if state == 'present':
|
|
if not ipa_group:
|
|
changed = True
|
|
if not module.check_mode:
|
|
ipa_group = client.group_add(name, item=module_group)
|
|
else:
|
|
diff = get_group_diff(client, ipa_group, module_group)
|
|
if len(diff) > 0:
|
|
changed = True
|
|
if not module.check_mode:
|
|
data = {}
|
|
for key in diff:
|
|
data[key] = module_group.get(key)
|
|
client.group_mod(name=name, item=data)
|
|
|
|
if group is not None:
|
|
changed = client.modify_if_diff(name, ipa_group.get('member_group', []), group,
|
|
client.group_add_member_group,
|
|
client.group_remove_member_group) or changed
|
|
|
|
if user is not None:
|
|
changed = client.modify_if_diff(name, ipa_group.get('member_user', []), user,
|
|
client.group_add_member_user,
|
|
client.group_remove_member_user) or changed
|
|
|
|
else:
|
|
if ipa_group:
|
|
changed = True
|
|
if not module.check_mode:
|
|
client.group_del(name)
|
|
|
|
return changed, client.group_find(name=name)
|
|
|
|
|
|
def main():
|
|
module = AnsibleModule(
|
|
argument_spec=dict(
|
|
cn=dict(type='str', required=True, aliases=['name']),
|
|
description=dict(type='str', required=False),
|
|
external=dict(type='bool', required=False),
|
|
gidnumber=dict(type='str', required=False, aliases=['gid']),
|
|
group=dict(type='list', required=False),
|
|
nonposix=dict(type='bool', required=False),
|
|
state=dict(type='str', required=False, default='present', choices=['present', 'absent']),
|
|
user=dict(type='list', required=False),
|
|
ipa_prot=dict(type='str', required=False, default='https', choices=['http', 'https']),
|
|
ipa_host=dict(type='str', required=False, default='ipa.example.com'),
|
|
ipa_port=dict(type='int', required=False, default=443),
|
|
ipa_user=dict(type='str', required=False, default='admin'),
|
|
ipa_pass=dict(type='str', required=True, no_log=True),
|
|
validate_certs=dict(type='bool', required=False, default=True),
|
|
),
|
|
supports_check_mode=True,
|
|
)
|
|
|
|
client = GroupIPAClient(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, group = ensure(module, client)
|
|
module.exit_json(changed=changed, group=group)
|
|
except Exception:
|
|
e = get_exception()
|
|
module.fail_json(msg=str(e))
|
|
|
|
|
|
if __name__ == '__main__':
|
|
main()
|