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
233 lines
6.7 KiB
Python
233 lines
6.7 KiB
Python
#!/usr/bin/python
|
|
# -*- coding: utf-8 -*-
|
|
# Copyright (c) 2019, Bram Verschueren <verschueren.bram@gmail.com>
|
|
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
|
|
|
DOCUMENTATION = '''
|
|
---
|
|
module: routers_info
|
|
short_description: Retrieve information about one or more OpenStack routers.
|
|
author: OpenStack Ansible SIG
|
|
description:
|
|
- Retrieve information about one or more routers from OpenStack.
|
|
options:
|
|
name:
|
|
description:
|
|
- Name or ID of the router
|
|
required: false
|
|
type: str
|
|
filters:
|
|
description:
|
|
- A dictionary of meta data to use for further filtering. Elements of
|
|
this dictionary may be additional dictionaries.
|
|
required: false
|
|
type: dict
|
|
suboptions:
|
|
project_id:
|
|
description:
|
|
- Filter the list result by the ID of the project that owns the resource.
|
|
type: str
|
|
aliases:
|
|
- tenant_id
|
|
name:
|
|
description:
|
|
- Filter the list result by the human-readable name of the resource.
|
|
type: str
|
|
description:
|
|
description:
|
|
- Filter the list result by the human-readable description of the resource.
|
|
type: str
|
|
is_admin_state_up:
|
|
description:
|
|
- Filter the list result by the administrative state of the resource, which is up (true) or down (false).
|
|
type: bool
|
|
revision_number:
|
|
description:
|
|
- Filter the list result by the revision number of the resource.
|
|
type: int
|
|
tags:
|
|
description:
|
|
- A list of tags to filter the list result by. Resources that match all tags in this list will be returned.
|
|
type: list
|
|
elements: str
|
|
requirements:
|
|
- "python >= 3.6"
|
|
- "openstacksdk"
|
|
extends_documentation_fragment:
|
|
- openstack.cloud.openstack
|
|
'''
|
|
|
|
EXAMPLES = '''
|
|
- name: Gather information about routers
|
|
openstack.cloud.routers_info:
|
|
auth:
|
|
auth_url: https://identity.example.com
|
|
username: user
|
|
password: password
|
|
project_name: someproject
|
|
register: result
|
|
|
|
- name: Show openstack routers
|
|
debug:
|
|
msg: "{{ result.routers }}"
|
|
|
|
- name: Gather information about a router by name
|
|
openstack.cloud.routers_info:
|
|
auth:
|
|
auth_url: https://identity.example.com
|
|
username: user
|
|
password: password
|
|
project_name: someproject
|
|
name: router1
|
|
register: result
|
|
|
|
- name: Show openstack routers
|
|
debug:
|
|
msg: "{{ result.routers }}"
|
|
|
|
- name: Gather information about a router with filter
|
|
openstack.cloud.routers_info:
|
|
auth:
|
|
auth_url: https://identity.example.com
|
|
username: user
|
|
password: password
|
|
project_name: someproject
|
|
filters:
|
|
is_admin_state_up: True
|
|
register: result
|
|
|
|
- name: Show openstack routers
|
|
debug:
|
|
msg: "{{ result.routers }}"
|
|
'''
|
|
|
|
RETURN = '''
|
|
routers:
|
|
description: has all the openstack information about the routers
|
|
returned: always, but can be null
|
|
type: list
|
|
elements: dict
|
|
contains:
|
|
availability_zones:
|
|
description: Availability zones
|
|
returned: success
|
|
type: list
|
|
availability_zone_hints:
|
|
description: Availability zone hints
|
|
returned: success
|
|
type: list
|
|
created_at:
|
|
description: Date and time when the router was created
|
|
returned: success
|
|
type: str
|
|
description:
|
|
description: Description notes of the router
|
|
returned: success
|
|
type: str
|
|
external_gateway_info:
|
|
description: The external gateway information of the router.
|
|
returned: success
|
|
type: dict
|
|
flavor_id:
|
|
description: ID of the flavor of the router
|
|
returned: success
|
|
type: str
|
|
id:
|
|
description: Unique UUID.
|
|
returned: success
|
|
type: str
|
|
interfaces_info:
|
|
description: List of connected interfaces.
|
|
returned: success
|
|
type: list
|
|
is_admin_state_up:
|
|
description: Network administrative state
|
|
returned: success
|
|
type: bool
|
|
is_distributed:
|
|
description: Indicates a distributed router.
|
|
returned: success
|
|
type: bool
|
|
is_ha:
|
|
description: Indicates a highly-available router.
|
|
returned: success
|
|
type: bool
|
|
name:
|
|
description: Name given to the router.
|
|
returned: success
|
|
type: str
|
|
project_id:
|
|
description: Project id associated with this router.
|
|
returned: success
|
|
type: str
|
|
revision_number:
|
|
description: Revision number
|
|
returned: success
|
|
type: int
|
|
routes:
|
|
description: The extra routes configuration for L3 router.
|
|
returned: success
|
|
type: list
|
|
status:
|
|
description: Router status.
|
|
returned: success
|
|
type: str
|
|
tags:
|
|
description: List of tags
|
|
returned: success
|
|
type: list
|
|
tenant_id:
|
|
description: Owner tenant ID
|
|
returned: success
|
|
type: str
|
|
updated_at:
|
|
description: Date of last update on the router
|
|
returned: success
|
|
type: str
|
|
'''
|
|
|
|
from ansible_collections.openstack.cloud.plugins.module_utils.openstack import OpenStackModule
|
|
|
|
|
|
class RouterInfoModule(OpenStackModule):
|
|
|
|
argument_spec = dict(
|
|
name=dict(required=False, default=None),
|
|
filters=dict(required=False, type='dict', default={})
|
|
)
|
|
module_kwargs = dict(
|
|
supports_check_mode=True
|
|
)
|
|
|
|
def run(self):
|
|
routers = [
|
|
router.to_dict(computed=False)
|
|
for router in self.conn.search_routers(
|
|
name_or_id=self.params['name'],
|
|
filters=self.params['filters'])]
|
|
|
|
# append interfaces_info attribute for backward compatibility
|
|
for router in routers:
|
|
interfaces_info = []
|
|
for port in self.conn.list_router_interfaces(router):
|
|
if port.device_owner != "network:router_gateway":
|
|
for ip_spec in port.fixed_ips:
|
|
int_info = {
|
|
'port_id': port.id,
|
|
'ip_address': ip_spec.get('ip_address'),
|
|
'subnet_id': ip_spec.get('subnet_id')
|
|
}
|
|
interfaces_info.append(int_info)
|
|
router['interfaces_info'] = interfaces_info
|
|
|
|
self.exit(changed=False, routers=routers)
|
|
|
|
|
|
def main():
|
|
module = RouterInfoModule()
|
|
module()
|
|
|
|
|
|
if __name__ == '__main__':
|
|
main()
|