mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-26 20:31:27 -07:00
0f893027c4
Start using this to construct shade OpenStack Cloud objects in a consistent manner. This will let us centralize things like dealing with password arguments and whatnot. It also allows us to introduce the ability to pass a fully formed config dict directly to the module. Migrate all OpenStack modules to use openstack_cloud_from_module. Have it return the shade library since it's responsible for importing shade and shade is needed for the exceptions. Only pull specific OpenStack arguments for the constructor Rather than passing **module.params to the shade constructor, pull out only the values that make sense. This should prevent the issues with module parameters stepping on shade parameters. Replace module.params.pop with module.params.get We don't need to pop these anymore since the shade constructor is now using opt-in values. Using real urls is ungood. Use example.com domains. Also, get rid of the antiquated port numbers.
144 lines
3.9 KiB
Python
144 lines
3.9 KiB
Python
#!/usr/bin/python
|
|
|
|
# Copyright (c) 2015 Hewlett-Packard Development Company, L.P.
|
|
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
|
|
|
from __future__ import absolute_import, division, print_function
|
|
__metaclass__ = type
|
|
|
|
|
|
ANSIBLE_METADATA = {'metadata_version': '1.1',
|
|
'status': ['preview'],
|
|
'supported_by': 'community'}
|
|
|
|
|
|
DOCUMENTATION = '''
|
|
---
|
|
module: os_networks_facts
|
|
short_description: Retrieve facts about one or more OpenStack networks.
|
|
version_added: "2.0"
|
|
author: "Davide Agnello (@dagnello)"
|
|
description:
|
|
- Retrieve facts about one or more networks from OpenStack.
|
|
requirements:
|
|
- "python >= 2.6"
|
|
- "shade"
|
|
options:
|
|
name:
|
|
description:
|
|
- Name or ID of the Network
|
|
required: false
|
|
filters:
|
|
description:
|
|
- A dictionary of meta data to use for further filtering. Elements of
|
|
this dictionary may be additional dictionaries.
|
|
required: false
|
|
availability_zone:
|
|
description:
|
|
- Ignored. Present for backwards compatibility
|
|
required: false
|
|
extends_documentation_fragment: openstack
|
|
'''
|
|
|
|
EXAMPLES = '''
|
|
- name: Gather facts about previously created networks
|
|
os_networks_facts:
|
|
auth:
|
|
auth_url: https://identity.example.com
|
|
username: user
|
|
password: password
|
|
project_name: someproject
|
|
|
|
- name: Show openstack networks
|
|
debug:
|
|
var: openstack_networks
|
|
|
|
- name: Gather facts about a previously created network by name
|
|
os_networks_facts:
|
|
auth:
|
|
auth_url: https://identity.example.com
|
|
username: user
|
|
password: password
|
|
project_name: someproject
|
|
name: network1
|
|
|
|
- name: Show openstack networks
|
|
debug:
|
|
var: openstack_networks
|
|
|
|
- name: Gather facts about a previously created network with filter
|
|
# Note: name and filters parameters are Not mutually exclusive
|
|
os_networks_facts:
|
|
auth:
|
|
auth_url: https://identity.example.com
|
|
username: user
|
|
password: password
|
|
project_name: someproject
|
|
filters:
|
|
tenant_id: 55e2ce24b2a245b09f181bf025724cbe
|
|
subnets:
|
|
- 057d4bdf-6d4d-4728-bb0f-5ac45a6f7400
|
|
- 443d4dc0-91d4-4998-b21c-357d10433483
|
|
|
|
- name: Show openstack networks
|
|
debug:
|
|
var: openstack_networks
|
|
'''
|
|
|
|
RETURN = '''
|
|
openstack_networks:
|
|
description: has all the openstack facts about the networks
|
|
returned: always, but can be null
|
|
type: complex
|
|
contains:
|
|
id:
|
|
description: Unique UUID.
|
|
returned: success
|
|
type: string
|
|
name:
|
|
description: Name given to the network.
|
|
returned: success
|
|
type: string
|
|
status:
|
|
description: Network status.
|
|
returned: success
|
|
type: string
|
|
subnets:
|
|
description: Subnet(s) included in this network.
|
|
returned: success
|
|
type: list of strings
|
|
tenant_id:
|
|
description: Tenant id associated with this network.
|
|
returned: success
|
|
type: string
|
|
shared:
|
|
description: Network shared flag.
|
|
returned: success
|
|
type: boolean
|
|
'''
|
|
|
|
from ansible.module_utils.basic import AnsibleModule
|
|
from ansible.module_utils.openstack import openstack_full_argument_spec, openstack_cloud_from_module
|
|
|
|
|
|
def main():
|
|
|
|
argument_spec = openstack_full_argument_spec(
|
|
name=dict(required=False, default=None),
|
|
filters=dict(required=False, type='dict', default=None)
|
|
)
|
|
module = AnsibleModule(argument_spec)
|
|
|
|
shade, cloud = openstack_cloud_from_module(module)
|
|
try:
|
|
networks = cloud.search_networks(module.params['name'],
|
|
module.params['filters'])
|
|
module.exit_json(changed=False, ansible_facts=dict(
|
|
openstack_networks=networks))
|
|
|
|
except shade.OpenStackCloudException as e:
|
|
module.fail_json(msg=str(e))
|
|
|
|
|
|
if __name__ == '__main__':
|
|
main()
|