diff options
Diffstat (limited to 'lib/ansible/modules/cloud/ovirt/ovirt_permission_info.py')
| -rw-r--r-- | lib/ansible/modules/cloud/ovirt/ovirt_permission_info.py | 161 |
1 files changed, 0 insertions, 161 deletions
diff --git a/lib/ansible/modules/cloud/ovirt/ovirt_permission_info.py b/lib/ansible/modules/cloud/ovirt/ovirt_permission_info.py deleted file mode 100644 index bec4621374..0000000000 --- a/lib/ansible/modules/cloud/ovirt/ovirt_permission_info.py +++ /dev/null @@ -1,161 +0,0 @@ -#!/usr/bin/python -# -*- coding: utf-8 -*- -# -# Copyright (c) 2016 Red Hat, Inc. -# -# 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.1', - 'status': ['preview'], - 'supported_by': 'community'} - - -DOCUMENTATION = ''' ---- -module: ovirt_permission_info -short_description: Retrieve information about one or more oVirt/RHV permissions -author: "Ondra Machacek (@machacekondra)" -version_added: "2.3" -description: - - "Retrieve information about one or more oVirt/RHV permissions." - - This module was called C(ovirt_permission_facts) before Ansible 2.9, returning C(ansible_facts). - Note that the M(ovirt_permission_info) module no longer returns C(ansible_facts)! -notes: - - "This module returns a variable C(ovirt_permissions), which - contains a list of permissions. You need to register the result with - the I(register) keyword to use it." -options: - user_name: - description: - - "Username of the user to manage. In most LDAPs it's I(uid) of the user, but in Active Directory you must specify I(UPN) of the user." - group_name: - description: - - "Name of the group to manage." - authz_name: - description: - - "Authorization provider of the user/group. In previous versions of oVirt/RHV known as domain." - required: true - aliases: ['domain'] - namespace: - description: - - "Namespace of the authorization provider, where user/group resides." - required: false -extends_documentation_fragment: ovirt_info -''' - -EXAMPLES = ''' -# Examples don't contain auth parameter for simplicity, -# look at ovirt_auth module to see how to reuse authentication: - -# Gather information about all permissions of user with username C(john): -- ovirt_permission_info: - user_name: john - authz_name: example.com-authz - register: result -- debug: - msg: "{{ result.ovirt_permissions }}" -''' - -RETURN = ''' -ovirt_permissions: - description: "List of dictionaries describing the permissions. Permission attributes are mapped to dictionary keys, - all permissions attributes can be found at following url: http://ovirt.github.io/ovirt-engine-api-model/master/#types/permission." - returned: On success. - type: list -''' - -import traceback - -try: - import ovirtsdk4 as sdk -except ImportError: - pass - -from ansible.module_utils.basic import AnsibleModule -from ansible.module_utils.ovirt import ( - check_sdk, - create_connection, - get_link_name, - ovirt_info_full_argument_spec, - search_by_name, -) - - -def _permissions_service(connection, module): - if module.params['user_name']: - service = connection.system_service().users_service() - entity = next( - iter( - service.list( - search='usrname={0}'.format( - '{0}@{1}'.format(module.params['user_name'], module.params['authz_name']) - ) - ) - ), - None - ) - else: - service = connection.system_service().groups_service() - entity = search_by_name(service, module.params['group_name']) - - if entity is None: - raise Exception("User/Group wasn't found.") - - return service.service(entity.id).permissions_service() - - -def main(): - argument_spec = ovirt_info_full_argument_spec( - authz_name=dict(required=True, aliases=['domain']), - user_name=dict(default=None), - group_name=dict(default=None), - namespace=dict(default=None), - ) - module = AnsibleModule(argument_spec) - is_old_facts = module._name == 'ovirt_permission_facts' - if is_old_facts: - module.deprecate("The 'ovirt_permission_facts' module has been renamed to 'ovirt_permission_info', " - "and the renamed one no longer returns ansible_facts", version='2.13') - - check_sdk(module) - - try: - auth = module.params.pop('auth') - connection = create_connection(auth) - permissions_service = _permissions_service(connection, module) - permissions = [] - for p in permissions_service.list(): - newperm = dict() - for key, value in p.__dict__.items(): - if value and isinstance(value, sdk.Struct): - newperm[key[1:]] = get_link_name(connection, value) - newperm['%s_id' % key[1:]] = value.id - permissions.append(newperm) - - result = dict(ovirt_permissions=permissions) - if is_old_facts: - module.exit_json(changed=False, ansible_facts=result) - else: - module.exit_json(changed=False, **result) - except Exception as e: - module.fail_json(msg=str(e), exception=traceback.format_exc()) - finally: - connection.close(logout=auth.get('token') is None) - - -if __name__ == '__main__': - main() |