mirror of
https://opendev.org/openstack/ansible-collections-openstack.git
synced 2026-07-25 17:24:28 +00:00
b87ae7dcce
With Ansible OpenStack collection 2.0.0 we break backward compatibility to older releases, mainly due to breaking changes coming with openstacksdk >=0.99.0. For example, results will change for most Ansible modules in this collection. We take this opportunity to drop the symbolic links with prefix os_ in plugins/modules and the plugin routing in meta/runtime.yml. This means users have to call modules of the Ansible OpenStack collection using their FQCN (Fully Qualified Collection Name) such as openstack.cloud.server. Short module names such as os_server will now raise an Ansible error. This also decreases the likelihood of incompatible Ansible code going undetected. Symbolic links were introduced to keep our collection backward compatible to user code which was written for old(er) Ansible releases which did not have support for collections and where OpenStack modules where named with a prefix os_ such as os_server which is nowadays known and stored as openstack.cloud.server. In Ansible aka ansible-base 2.10, a internal routing table lib/ansible/config/ansible_builtin_runtime.yml [1] was introduced which Ansible uses to resolve deprecated module names missing the FQCN (Fully Qualified Collection Name). Additionally, collections can define their own plugin routing table in meta/runtime.yml [2] which we did. In ansible-base 2.10 and ansible-core 2.11 or later, if a user uses a short module name and the collections keyword is not used, Ansible will first look in the internal routing table, get an FQCN, and then looks in the collection for that FQCN. If there is another routing entry for that new name in that collection's meta/runtime.yml, Ansible will continue with that redirect. If it does not find another redirect, Ansible will look for the plugin itself, so it will not find a redirect in the collection before looking at its internal redirects. Except if the user uses a FQCN, then it looks directly in that collection. Ansible 2.9 and 2.8 do not have any notion of these redirects with a plugin routing table, backward compatibility with deprecated os_* module names is solely achieved with symbolic links. Ansible releases older than 2.11 are EOL [3], so usage of os_* symlinks should reduce soon. [1] https://github.com/ansible/ansible/blob/devel/lib/ansible/config/ansible_builtin_runtime.yml [2] https://github.com/openstack/ansible-collections-openstack/blob/master/meta/runtime.yml [3] https://docs.ansible.com/ansible/devel/reference_appendices/release_and_maintenance.html Change-Id: I28cc05c95419b72552899c926721eb87fb6f0868
168 lines
4.7 KiB
Python
168 lines
4.7 KiB
Python
#!/usr/bin/python
|
|
# Copyright (c) 2016 Hewlett-Packard Enterprise Corporation
|
|
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
|
|
|
DOCUMENTATION = '''
|
|
---
|
|
module: identity_user_info
|
|
short_description: Retrieve information about one or more OpenStack users
|
|
author: OpenStack Ansible SIG
|
|
description:
|
|
- Retrieve information about a one or more OpenStack users
|
|
options:
|
|
name:
|
|
description:
|
|
- Name or ID of the user
|
|
type: str
|
|
domain:
|
|
description:
|
|
- Name or ID of the domain containing the user if the cloud supports domains
|
|
type: str
|
|
filters:
|
|
description:
|
|
- A dictionary of meta data to use for further filtering. Elements of
|
|
this dictionary may be additional dictionaries.
|
|
type: dict
|
|
default: {}
|
|
requirements:
|
|
- "python >= 3.6"
|
|
- "openstacksdk"
|
|
|
|
extends_documentation_fragment:
|
|
- openstack.cloud.openstack
|
|
'''
|
|
|
|
EXAMPLES = '''
|
|
# Gather information about previously created users
|
|
- openstack.cloud.identity_user_info:
|
|
cloud: awesomecloud
|
|
register: result
|
|
- debug:
|
|
msg: "{{ result.users }}"
|
|
|
|
# Gather information about a previously created user by name
|
|
- openstack.cloud.identity_user_info:
|
|
cloud: awesomecloud
|
|
name: demouser
|
|
register: result
|
|
- debug:
|
|
msg: "{{ result.users }}"
|
|
|
|
# Gather information about a previously created user in a specific domain
|
|
- openstack.cloud.identity_user_info:
|
|
cloud: awesomecloud
|
|
name: demouser
|
|
domain: admindomain
|
|
register: result
|
|
- debug:
|
|
msg: "{{ result.users }}"
|
|
|
|
# Gather information about a previously created user in a specific domain with filter
|
|
- openstack.cloud.identity_user_info:
|
|
cloud: awesomecloud
|
|
name: demouser
|
|
domain: admindomain
|
|
filters:
|
|
enabled: False
|
|
register: result
|
|
- debug:
|
|
msg: "{{ result.users }}"
|
|
'''
|
|
|
|
|
|
RETURN = '''
|
|
users:
|
|
description: has all the OpenStack information about users
|
|
returned: always
|
|
type: list
|
|
elements: dict
|
|
contains:
|
|
id:
|
|
description: Unique UUID.
|
|
returned: success
|
|
type: str
|
|
name:
|
|
description: Username of the user.
|
|
returned: success
|
|
type: str
|
|
default_project_id:
|
|
description: Default project ID of the user
|
|
returned: success
|
|
type: str
|
|
description:
|
|
description: The description of this user
|
|
returned: success
|
|
type: str
|
|
domain_id:
|
|
description: Domain ID containing the user
|
|
returned: success
|
|
type: str
|
|
email:
|
|
description: Email of the user
|
|
returned: success
|
|
type: str
|
|
is_enabled:
|
|
description: Flag to indicate if the user is enabled
|
|
returned: success
|
|
type: bool
|
|
links:
|
|
description: The links for the user resource
|
|
returned: success
|
|
type: complex
|
|
contains:
|
|
self:
|
|
description: Link to this user resource
|
|
returned: success
|
|
type: str
|
|
password:
|
|
description: The default form of credential used during authentication.
|
|
returned: success
|
|
type: str
|
|
password_expires_at:
|
|
description: The date and time when the password expires. The time zone is UTC. A Null value means the password never expires.
|
|
returned: success
|
|
type: str
|
|
username:
|
|
description: Username with Identity API v2 (OpenStack Pike or earlier) else Null
|
|
returned: success
|
|
type: str
|
|
'''
|
|
|
|
from ansible_collections.openstack.cloud.plugins.module_utils.openstack import OpenStackModule
|
|
|
|
|
|
class IdentityUserInfoModule(OpenStackModule):
|
|
argument_spec = dict(
|
|
name=dict(required=False, default=None),
|
|
domain=dict(required=False, default=None),
|
|
filters=dict(required=False, type='dict', default={}),
|
|
)
|
|
module_kwargs = dict(
|
|
supports_check_mode=True
|
|
)
|
|
|
|
def run(self):
|
|
name = self.params['name']
|
|
domain = self.params['domain']
|
|
filters = self.params['filters']
|
|
|
|
args = {}
|
|
if domain:
|
|
dom_obj = self.conn.identity.find_domain(domain)
|
|
if dom_obj is None:
|
|
self.fail_json(
|
|
msg="Domain name or ID '{0}' does not exist".format(domain))
|
|
args['domain_id'] = dom_obj.id
|
|
|
|
users = [user.to_dict(computed=False) for user in self.conn.search_users(name, filters, **args)]
|
|
self.exit_json(changed=False, users=users)
|
|
|
|
|
|
def main():
|
|
module = IdentityUserInfoModule()
|
|
module()
|
|
|
|
|
|
if __name__ == '__main__':
|
|
main()
|