mirror of
https://opendev.org/openstack/ansible-collections-openstack.git
synced 2026-05-07 22:03:09 +00:00
Refactored identity_user{,_info} modules
Change-Id: Iae52d1a86f8f78790290be3966681f2277b9701d
This commit is contained in:
Jakob Meng
@@ -4,126 +4,98 @@
|
||||
# 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 = '''
|
||||
DOCUMENTATION = r'''
|
||||
---
|
||||
module: identity_user_info
|
||||
short_description: Retrieve information about one or more OpenStack users
|
||||
short_description: Fetch OpenStack identity (Keystone) users
|
||||
author: OpenStack Ansible SIG
|
||||
description:
|
||||
- Retrieve information about a one or more OpenStack users
|
||||
- Fetch OpenStack identity (Keystone) 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: {}
|
||||
domain:
|
||||
description:
|
||||
- Name or ID of the domain containing the user.
|
||||
type: str
|
||||
filters:
|
||||
description:
|
||||
- A dictionary of meta data to use for further filtering. Elements of
|
||||
this dictionary may be additional dictionaries.
|
||||
type: dict
|
||||
name:
|
||||
description:
|
||||
- Name or ID of the user.
|
||||
type: str
|
||||
extends_documentation_fragment:
|
||||
- openstack.cloud.openstack
|
||||
- openstack.cloud.openstack
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
# Gather information about previously created users
|
||||
- openstack.cloud.identity_user_info:
|
||||
EXAMPLES = r'''
|
||||
- name: Gather 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:
|
||||
- name: Gather 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:
|
||||
- name: Gather 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:
|
||||
- name: Gather previously created user with filters
|
||||
openstack.cloud.identity_user_info:
|
||||
cloud: awesomecloud
|
||||
name: demouser
|
||||
domain: admindomain
|
||||
filters:
|
||||
enabled: False
|
||||
register: result
|
||||
- debug:
|
||||
msg: "{{ result.users }}"
|
||||
is_enabled: False
|
||||
'''
|
||||
|
||||
|
||||
RETURN = '''
|
||||
RETURN = r'''
|
||||
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
|
||||
description: Dictionary describing all matching identity users.
|
||||
returned: always
|
||||
type: list
|
||||
elements: dict
|
||||
contains:
|
||||
id:
|
||||
description: Unique UUID.
|
||||
type: str
|
||||
name:
|
||||
description: Username of the user.
|
||||
type: str
|
||||
default_project_id:
|
||||
description: Default project ID of the user
|
||||
type: str
|
||||
description:
|
||||
description: The description of this user
|
||||
type: str
|
||||
domain_id:
|
||||
description: Domain ID containing the user
|
||||
type: str
|
||||
email:
|
||||
description: Email of the user
|
||||
type: str
|
||||
is_enabled:
|
||||
description: Flag to indicate if the user is enabled
|
||||
type: bool
|
||||
links:
|
||||
description: The links for the user resource
|
||||
type: dict
|
||||
password:
|
||||
description: The default form of credential used during authentication.
|
||||
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.
|
||||
type: str
|
||||
username:
|
||||
description: Username with Identity API v2 (OpenStack Pike or earlier)
|
||||
else Null.
|
||||
type: str
|
||||
'''
|
||||
|
||||
from ansible_collections.openstack.cloud.plugins.module_utils.openstack import OpenStackModule
|
||||
@@ -131,9 +103,9 @@ from ansible_collections.openstack.cloud.plugins.module_utils.openstack import O
|
||||
|
||||
class IdentityUserInfoModule(OpenStackModule):
|
||||
argument_spec = dict(
|
||||
name=dict(),
|
||||
domain=dict(),
|
||||
filters=dict(type='dict', default={}),
|
||||
filters=dict(type='dict'),
|
||||
name=dict(),
|
||||
)
|
||||
module_kwargs = dict(
|
||||
supports_check_mode=True
|
||||
@@ -141,19 +113,20 @@ class IdentityUserInfoModule(OpenStackModule):
|
||||
|
||||
def run(self):
|
||||
name = self.params['name']
|
||||
domain = self.params['domain']
|
||||
filters = self.params['filters']
|
||||
filters = self.params['filters'] or {}
|
||||
|
||||
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
|
||||
kwargs = {}
|
||||
domain_name_or_id = self.params['domain']
|
||||
if domain_name_or_id:
|
||||
domain = self.conn.identity.find_domain(domain_name_or_id)
|
||||
if domain is None:
|
||||
self.exit_json(changed=False, groups=[])
|
||||
kwargs['domain_id'] = domain['id']
|
||||
|
||||
users = [user.to_dict(computed=False) for user in self.conn.search_users(name, filters, **args)]
|
||||
self.exit_json(changed=False, users=users)
|
||||
self.exit_json(changed=False,
|
||||
users=[u.to_dict(computed=False)
|
||||
for u in self.conn.search_users(name, filters,
|
||||
**kwargs)])
|
||||
|
||||
|
||||
def main():
|
||||
|
||||
Reference in New Issue
Block a user