1b38b7c500
With "extends_documentation_fragment: ['openstack.cloud.openstack']" it is not necessary to list required Python libraries in section 'requirements' of DOCUMENTATION docstring in modules. Ansible will merge requirements from doc fragments and DOCUMENTATION docstring which previously resulted in duplicates such as in server module [0]: * openstacksdk * openstacksdk >= 0.36, < 0.99.0 * python >= 3.6 When removing the 'requirements' section from server module, then Ansible will list openstacksdk once only: * openstacksdk >= 0.36, < 0.99.0 * python >= 3.6 To see what documentation Ansible will produce for server module run: ansible-doc --type module openstack.cloud.server [0] https://docs.ansible.com/ansible/latest/collections/openstack/\ cloud/server_module.html Change-Id: I727ed95ee480bb644b5a533f6a9526973677064c
118 lines
3.0 KiB
Python
118 lines
3.0 KiB
Python
#!/usr/bin/python
|
|
# -*- coding: utf-8 -*-
|
|
|
|
# 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_domain_info
|
|
short_description: Retrieve information about one or more OpenStack domains
|
|
author: OpenStack Ansible SIG
|
|
description:
|
|
- Retrieve information about a one or more OpenStack domains
|
|
options:
|
|
name:
|
|
description:
|
|
- Name or ID of the domain
|
|
type: str
|
|
filters:
|
|
description:
|
|
- A dictionary of meta data to use for filtering. Elements of
|
|
this dictionary may be additional dictionaries.
|
|
type: dict
|
|
extends_documentation_fragment:
|
|
- openstack.cloud.openstack
|
|
'''
|
|
|
|
EXAMPLES = '''
|
|
# Gather information about previously created domain
|
|
- openstack.cloud.identity_domain_info:
|
|
cloud: awesomecloud
|
|
register: result
|
|
- debug:
|
|
msg: "{{ result.openstack_domains }}"
|
|
|
|
# Gather information about a previously created domain by name
|
|
- openstack.cloud.identity_domain_info:
|
|
cloud: awesomecloud
|
|
name: demodomain
|
|
register: result
|
|
- debug:
|
|
msg: "{{ result.openstack_domains }}"
|
|
|
|
# Gather information about a previously created domain with filter
|
|
- openstack.cloud.identity_domain_info:
|
|
cloud: awesomecloud
|
|
name: demodomain
|
|
filters:
|
|
enabled: false
|
|
register: result
|
|
- debug:
|
|
msg: "{{ result.openstack_domains }}"
|
|
'''
|
|
|
|
|
|
RETURN = '''
|
|
openstack_domains:
|
|
description: has all the OpenStack information about domains
|
|
returned: always, but can be null
|
|
type: list
|
|
elements: dict
|
|
contains:
|
|
id:
|
|
description: Unique UUID.
|
|
returned: success
|
|
type: str
|
|
name:
|
|
description: Name given to the domain.
|
|
returned: success
|
|
type: str
|
|
description:
|
|
description: Description of the domain.
|
|
returned: success
|
|
type: str
|
|
is_enabled:
|
|
description: Flag to indicate if the domain is enabled.
|
|
returned: success
|
|
type: bool
|
|
links:
|
|
type: list
|
|
returned: success
|
|
description: The links related to the domain resource
|
|
'''
|
|
|
|
from ansible_collections.openstack.cloud.plugins.module_utils.openstack import OpenStackModule
|
|
|
|
|
|
class IdentityDomainInfoModule(OpenStackModule):
|
|
argument_spec = dict(
|
|
name=dict(),
|
|
filters=dict(type='dict'),
|
|
)
|
|
|
|
module_kwargs = dict(
|
|
supports_check_mode=True
|
|
)
|
|
|
|
def run(self):
|
|
name = self.params['name']
|
|
filters = self.params['filters'] or {}
|
|
|
|
args = {}
|
|
if name:
|
|
args['name_or_id'] = name
|
|
args['filters'] = filters
|
|
|
|
domains = [d.to_dict(computed=False) for d in self.conn.search_domains(**args)]
|
|
self.exit_json(changed=False, openstack_domains=domains)
|
|
|
|
|
|
def main():
|
|
module = IdentityDomainInfoModule()
|
|
module()
|
|
|
|
|
|
if __name__ == '__main__':
|
|
main()
|