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.
157 lines
4.3 KiB
Python
157 lines
4.3 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_subnets_facts
|
|
short_description: Retrieve facts about one or more OpenStack subnets.
|
|
version_added: "2.0"
|
|
author: "Davide Agnello (@dagnello)"
|
|
description:
|
|
- Retrieve facts about one or more subnets from OpenStack.
|
|
requirements:
|
|
- "python >= 2.6"
|
|
- "shade"
|
|
options:
|
|
subnet:
|
|
description:
|
|
- Name or ID of the subnet
|
|
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 subnets
|
|
os_subnets_facts:
|
|
auth:
|
|
auth_url: https://identity.example.com
|
|
username: user
|
|
password: password
|
|
project_name: someproject
|
|
|
|
- name: Show openstack subnets
|
|
debug:
|
|
var: openstack_subnets
|
|
|
|
- name: Gather facts about a previously created subnet by name
|
|
os_subnets_facts:
|
|
auth:
|
|
auth_url: https://identity.example.com
|
|
username: user
|
|
password: password
|
|
project_name: someproject
|
|
name: subnet1
|
|
|
|
- name: Show openstack subnets
|
|
debug:
|
|
var: openstack_subnets
|
|
|
|
- name: Gather facts about a previously created subnet with filter
|
|
# Note: name and filters parameters are not mutually exclusive
|
|
os_subnets_facts:
|
|
auth:
|
|
auth_url: https://identity.example.com
|
|
username: user
|
|
password: password
|
|
project_name: someproject
|
|
filters:
|
|
tenant_id: 55e2ce24b2a245b09f181bf025724cbe
|
|
|
|
- name: Show openstack subnets
|
|
debug:
|
|
var: openstack_subnets
|
|
'''
|
|
|
|
RETURN = '''
|
|
openstack_subnets:
|
|
description: has all the openstack facts about the subnets
|
|
returned: always, but can be null
|
|
type: complex
|
|
contains:
|
|
id:
|
|
description: Unique UUID.
|
|
returned: success
|
|
type: string
|
|
name:
|
|
description: Name given to the subnet.
|
|
returned: success
|
|
type: string
|
|
network_id:
|
|
description: Network ID this subnet belongs in.
|
|
returned: success
|
|
type: string
|
|
cidr:
|
|
description: Subnet's CIDR.
|
|
returned: success
|
|
type: string
|
|
gateway_ip:
|
|
description: Subnet's gateway ip.
|
|
returned: success
|
|
type: string
|
|
enable_dhcp:
|
|
description: DHCP enable flag for this subnet.
|
|
returned: success
|
|
type: bool
|
|
ip_version:
|
|
description: IP version for this subnet.
|
|
returned: success
|
|
type: int
|
|
tenant_id:
|
|
description: Tenant id associated with this subnet.
|
|
returned: success
|
|
type: string
|
|
dns_nameservers:
|
|
description: DNS name servers for this subnet.
|
|
returned: success
|
|
type: list of strings
|
|
allocation_pools:
|
|
description: Allocation pools associated with this subnet.
|
|
returned: success
|
|
type: list of dicts
|
|
'''
|
|
|
|
from ansible.module_utils.basic import AnsibleModule
|
|
from ansible.module_utils.openstack import openstack_full_argument_spec, openstack_module_kwargs, 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:
|
|
subnets = cloud.search_subnets(module.params['name'],
|
|
module.params['filters'])
|
|
module.exit_json(changed=False, ansible_facts=dict(
|
|
openstack_subnets=subnets))
|
|
|
|
except shade.OpenStackCloudException as e:
|
|
module.fail_json(msg=str(e))
|
|
|
|
|
|
if __name__ == '__main__':
|
|
main()
|