mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
124 lines
4.2 KiB
Python
124 lines
4.2 KiB
Python
#!/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/>.
|
|
#
|
|
|
|
from __future__ import absolute_import, division, print_function
|
|
__metaclass__ = type
|
|
|
|
DOCUMENTATION = '''
|
|
---
|
|
module: ovirt_user_facts
|
|
short_description: Retrieve information about one or more oVirt/RHV users
|
|
author: "Ondra Machacek (@machacekondra)"
|
|
deprecated:
|
|
removed_in: "2.10"
|
|
why: When migrating to collection we decided to use only _info modules.
|
|
alternative: Use M(ovirt_user_info) instead
|
|
description:
|
|
- "Retrieve information about one or more oVirt/RHV users."
|
|
- This module was called C(ovirt_user_facts) before Ansible 2.9, returning C(ansible_facts).
|
|
Note that the M(ovirt_user_info) module no longer returns C(ansible_facts)!
|
|
notes:
|
|
- "This module returns a variable C(ovirt_users), which
|
|
contains a list of users. You need to register the result with
|
|
the I(register) keyword to use it."
|
|
options:
|
|
pattern:
|
|
description:
|
|
- "Search term which is accepted by oVirt/RHV search backend."
|
|
- "For example to search user X use following pattern: name=X"
|
|
extends_documentation_fragment:
|
|
- ovirt.ovirt.ovirt_info
|
|
|
|
'''
|
|
|
|
EXAMPLES = '''
|
|
# Examples don't contain auth parameter for simplicity,
|
|
# look at ovirt_auth module to see how to reuse authentication:
|
|
|
|
- name: Gather information about all users which first names start with john
|
|
ovirt_user_info:
|
|
pattern: name=john*
|
|
register: result
|
|
|
|
- name: Print gathered information
|
|
debug:
|
|
msg: "{{ result.ovirt_users }}"
|
|
'''
|
|
|
|
RETURN = '''
|
|
ovirt_users:
|
|
description: "List of dictionaries describing the users. User attributes are mapped to dictionary keys,
|
|
all users attributes can be found at following url: http://ovirt.github.io/ovirt-engine-api-model/master/#types/user."
|
|
returned: On success.
|
|
type: list
|
|
'''
|
|
|
|
import traceback
|
|
|
|
from ansible.module_utils.common.removed import removed_module
|
|
from ansible.module_utils.basic import AnsibleModule
|
|
from ansible_collections.ovirt.ovirt.plugins.module_utils.ovirt import (
|
|
check_sdk,
|
|
create_connection,
|
|
get_dict_of_struct,
|
|
ovirt_info_full_argument_spec,
|
|
)
|
|
|
|
|
|
def main():
|
|
argument_spec = ovirt_info_full_argument_spec(
|
|
pattern=dict(default='', required=False),
|
|
)
|
|
module = AnsibleModule(argument_spec)
|
|
is_old_facts = module._name in ('ovirt_user_facts', 'community.general.ovirt_user_facts')
|
|
if is_old_facts:
|
|
module.deprecate("The 'ovirt_user_facts' module has been renamed to 'ovirt_user_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)
|
|
users_service = connection.system_service().users_service()
|
|
users = users_service.list(search=module.params['pattern'])
|
|
result = dict(
|
|
ovirt_users=[
|
|
get_dict_of_struct(
|
|
struct=c,
|
|
connection=connection,
|
|
fetch_nested=module.params.get('fetch_nested'),
|
|
attributes=module.params.get('nested_attributes'),
|
|
) for c in users
|
|
],
|
|
)
|
|
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__':
|
|
removed_module("2.10")
|