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
282 lines
9.1 KiB
Python
282 lines
9.1 KiB
Python
#!/usr/bin/python
|
|
|
|
# Copyright (c) 2016 IBM
|
|
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
|
|
|
DOCUMENTATION = '''
|
|
module: port_info
|
|
short_description: Retrieve information about ports within OpenStack.
|
|
author: OpenStack Ansible SIG
|
|
description:
|
|
- Retrieve information about ports from OpenStack.
|
|
options:
|
|
port:
|
|
description:
|
|
- Unique name or ID of a port.
|
|
type: str
|
|
filters:
|
|
description:
|
|
- A dictionary of meta data to use for further filtering. Elements
|
|
of this dictionary will be matched passed to the API as query
|
|
parameter filters.
|
|
type: dict
|
|
requirements:
|
|
- "python >= 3.6"
|
|
- "openstacksdk"
|
|
|
|
extends_documentation_fragment:
|
|
- openstack.cloud.openstack
|
|
'''
|
|
|
|
EXAMPLES = '''
|
|
# Gather information about all ports
|
|
- openstack.cloud.port_info:
|
|
cloud: mycloud
|
|
register: result
|
|
|
|
- debug:
|
|
msg: "{{ result.ports}}"
|
|
|
|
# Gather information about a single port
|
|
- openstack.cloud.port_info:
|
|
cloud: mycloud
|
|
port: 6140317d-e676-31e1-8a4a-b1913814a471
|
|
|
|
# Gather information about all ports that have device_id set to a specific value
|
|
# and with a status of ACTIVE.
|
|
- openstack.cloud.port_info:
|
|
cloud: mycloud
|
|
filters:
|
|
device_id: 1038a010-3a37-4a9d-82ea-652f1da36597
|
|
status: ACTIVE
|
|
'''
|
|
|
|
RETURN = '''
|
|
ports:
|
|
description: List of port dictionaries. A subset of the dictionary keys
|
|
listed below may be returned, depending on your cloud provider.
|
|
returned: always
|
|
type: list
|
|
elements: dict
|
|
contains:
|
|
allowed_address_pairs:
|
|
description: A set of zero or more allowed address pairs. An
|
|
address pair consists of an IP address and MAC address.
|
|
returned: success
|
|
type: list
|
|
sample: []
|
|
binding_host_id:
|
|
description: The UUID of the host where the port is allocated.
|
|
returned: success
|
|
type: str
|
|
sample: "b4bd682d-234a-4091-aa5b-4b025a6a7759"
|
|
binding_profile:
|
|
description: A dictionary the enables the application running on
|
|
the host to pass and receive VIF port-specific
|
|
information to the plug-in.
|
|
returned: success
|
|
type: dict
|
|
sample: {}
|
|
binding_vif_details:
|
|
description: A dictionary that enables the application to pass
|
|
information about functions that the Networking API
|
|
provides.
|
|
returned: success
|
|
type: dict
|
|
binding_vif_type:
|
|
description: The VIF type for the port.
|
|
returned: success
|
|
type: dict
|
|
binding_vnic_type:
|
|
description: The virtual network interface card (vNIC) type that is
|
|
bound to the neutron port.
|
|
returned: success
|
|
type: str
|
|
sample: "normal"
|
|
created_at:
|
|
description: Date the port was created
|
|
returned: success
|
|
type: str
|
|
sample: "2022-02-03T13:28:25Z"
|
|
data_plane_status:
|
|
description: Status of the underlying data plane of a port.
|
|
returned: success
|
|
type: str
|
|
description:
|
|
description: Description of a port
|
|
returned: success
|
|
type: str
|
|
device_id:
|
|
description: The UUID of the device that uses this port.
|
|
returned: success
|
|
type: str
|
|
sample: "b4bd682d-234a-4091-aa5b-4b025a6a7759"
|
|
device_owner:
|
|
description: The UUID of the entity that uses this port.
|
|
returned: success
|
|
type: str
|
|
sample: "network:router_interface"
|
|
device_profile:
|
|
description: Device profile
|
|
returned: success
|
|
type: str
|
|
dns_assignment:
|
|
description: DNS assignment information.
|
|
returned: success
|
|
type: list
|
|
dns_domain:
|
|
description: A valid DNS domain
|
|
returned: success
|
|
type: str
|
|
dns_name:
|
|
description: DNS name
|
|
returned: success
|
|
type: str
|
|
extra_dhcp_opts:
|
|
description: A set of zero or more extra DHCP option pairs.
|
|
An option pair consists of an option value and name.
|
|
returned: success
|
|
type: list
|
|
sample: []
|
|
fixed_ips:
|
|
description: The IP addresses for the port. Includes the IP address
|
|
and UUID of the subnet.
|
|
returned: success
|
|
type: list
|
|
id:
|
|
description: The UUID of the port.
|
|
returned: success
|
|
type: str
|
|
sample: "3ec25c97-7052-4ab8-a8ba-92faf84148de"
|
|
ip_allocation:
|
|
description: Indicates when ports use either deferred, immediate
|
|
or no IP allocation (none).
|
|
returned: success
|
|
type: str
|
|
is_admin_state_up:
|
|
description: The administrative state of the router, which is
|
|
up (true) or down (false).
|
|
returned: success
|
|
type: bool
|
|
sample: true
|
|
is_port_security_enabled:
|
|
description: The port security status. The status is enabled (true) or disabled (false).
|
|
returned: success
|
|
type: bool
|
|
sample: false
|
|
mac_address:
|
|
description: The MAC address.
|
|
returned: success
|
|
type: str
|
|
sample: "00:00:5E:00:53:42"
|
|
name:
|
|
description: The port name.
|
|
returned: success
|
|
type: str
|
|
sample: "port_name"
|
|
network_id:
|
|
description: The UUID of the attached network.
|
|
returned: success
|
|
type: str
|
|
sample: "dd1ede4f-3952-4131-aab6-3b8902268c7d"
|
|
numa_affinity_policy:
|
|
description: The port NUMA affinity policy requested during the
|
|
virtual machine scheduling. Values are None, required,
|
|
preferred or legacy.
|
|
returned: success
|
|
type: str
|
|
sample: "required"
|
|
project_id:
|
|
description: The ID of the project.
|
|
returned: success
|
|
type: str
|
|
sample: "aa1ede4f-3952-4131-aab6-3b8902268c7d"
|
|
propagate_uplink_status:
|
|
description: The uplink status propagation of the port.
|
|
returned: success
|
|
type: bool
|
|
sample: false
|
|
qos_network_policy_id:
|
|
description: The ID of the QoS policy of the network where this
|
|
port is plugged.
|
|
returned: success
|
|
type: str
|
|
sample: "1e4f3958-c0c9-4dec-82fa-ed2dc1c5cb34"
|
|
qos_policy_id:
|
|
description: The ID of the QoS policy associated with the port.
|
|
returned: success
|
|
type: str
|
|
sample: "b20bb47f-5d6d-45a6-8fe7-2c1b44f0db73"
|
|
resource_request:
|
|
description: Expose Placement resources i.e. minimum-bandwidth
|
|
and traits i.e. vnic-type, physnet requested by a
|
|
port to Nova and Placement
|
|
returned: success
|
|
type: str
|
|
revision_number:
|
|
description: The revision number of the resource.
|
|
returned: success
|
|
type: int
|
|
sample: 0
|
|
security_group_ids:
|
|
description: The UUIDs of any attached security groups.
|
|
returned: success
|
|
type: list
|
|
status:
|
|
description: The port status.
|
|
returned: success
|
|
type: str
|
|
sample: "ACTIVE"
|
|
tags:
|
|
description: The list of tags on the resource.
|
|
returned: success
|
|
type: list
|
|
sample: []
|
|
tenant_id:
|
|
description: The UUID of the tenant who owns the network. Deprecated.
|
|
returned: success
|
|
type: str
|
|
sample: "51fce036d7984ba6af4f6c849f65ef00"
|
|
trunk_details:
|
|
description: The details about the trunk.
|
|
returned: success
|
|
type: dict
|
|
updated_at:
|
|
description: Last port update
|
|
returned: success
|
|
type: str
|
|
sample: "2022-02-03T13:28:25Z"
|
|
|
|
'''
|
|
|
|
from ansible_collections.openstack.cloud.plugins.module_utils.openstack import OpenStackModule
|
|
|
|
|
|
class NetworkPortInfoModule(OpenStackModule):
|
|
argument_spec = dict(
|
|
port=dict(type='str', required=False),
|
|
filters=dict(type='dict', required=False, default={}),
|
|
)
|
|
module_kwargs = dict(
|
|
supports_check_mode=True
|
|
)
|
|
|
|
def run(self):
|
|
port = self.params['port']
|
|
filters = self.params['filters']
|
|
|
|
ports = self.conn.search_ports(port, filters)
|
|
|
|
ports = [p.to_dict(computed=False) for p in ports]
|
|
|
|
self.exit_json(changed=False, ports=ports)
|
|
|
|
|
|
def main():
|
|
module = NetworkPortInfoModule()
|
|
module()
|
|
|
|
|
|
if __name__ == '__main__':
|
|
main()
|