openstack.cloud.port_info module – Retrieve information about ports within OpenStack.
Note
This module is part of the openstack.cloud collection (version 1.10.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install openstack.cloud
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: openstack.cloud.port_info
.
Synopsis
Retrieve information about ports from OpenStack.
This module was called
openstack.cloud.port_facts
before Ansible 2.9, returningansible_facts
. Note that the openstack.cloud.port_info module no longer returnsansible_facts
!
Requirements
The below requirements are needed on the host that executes this module.
openstacksdk
openstacksdk >= 0.36, < 0.99.0
python >= 3.6
Parameters
Parameter |
Comments |
---|---|
How long should the socket layer wait before timing out for API calls. If this is omitted, nothing will be passed to the requests library. |
|
Dictionary containing auth information as needed by the cloud’s auth plugin strategy. For the default password plugin, this would contain auth_url, username, password, project_name and any information about domains (for example, user_domain_name or project_domain_name) if the cloud supports them. For other plugins, this param will need to contain whatever parameters that auth plugin requires. This parameter is not needed if a named cloud is provided or OpenStack OS_* environment variables are present. |
|
Name of the auth plugin to use. If the cloud uses something other than password authentication, the name of the plugin should be indicated here and the contents of the auth parameter should be updated accordingly. |
|
Ignored. Present for backwards compatibility |
|
A path to a CA Cert bundle that can be used as part of verifying SSL API requests. |
|
A path to a client certificate to use as part of the SSL transaction. |
|
A path to a client key to use as part of the SSL transaction. |
|
Named cloud or cloud config to operate against. If cloud is a string, it references a named cloud config as defined in an OpenStack clouds.yaml file. Provides default values for auth and auth_type. This parameter is not needed if auth is provided or if OpenStack OS_* environment variables are present. If cloud is a dict, it contains a complete cloud configuration like would be in a section of clouds.yaml. |
|
A dictionary of meta data to use for further filtering. Elements of this dictionary will be matched against the returned port dictionaries. Matching is currently limited to strings within the port dictionary, or strings within nested dictionaries. |
|
Endpoint URL type to fetch from the service catalog. Choices:
|
|
Unique name or ID of a port. |
|
Name of the region. |
|
Log level of the OpenStackSDK Choices:
|
|
Path to the logfile of the OpenStackSDK. If empty no log is written |
|
How long should ansible wait for the requested resource. Default: |
|
Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to Choices:
|
|
Should ansible wait until the requested resource is complete. Choices:
|
Notes
Note
The standard OpenStack environment variables, such as
OS_USERNAME
may be used instead of providing explicit values.Auth information is driven by openstacksdk, which means that values can come from a yaml config file in /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml or ~/.config/openstack/clouds.yaml, then from standard environment variables, then finally by explicit parameters in plays. More information can be found at https://docs.openstack.org/openstacksdk/
Examples
# Gather information about all ports
- openstack.cloud.port_info:
cloud: mycloud
register: result
- debug:
msg: "{{ result.openstack_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 Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
List of port dictionaries. A subset of the dictionary keys listed below may be returned, depending on your cloud provider. Returned: always, but can be null |
|
The administrative state of the router, which is up (true) or down (false). Returned: success Sample: |
|
A set of zero or more allowed address pairs. An address pair consists of an IP address and MAC address. Returned: success Sample: |
|
The UUID of the host where the port is allocated. Returned: success Sample: |
|
A dictionary the enables the application running on the host to pass and receive VIF port-specific information to the plug-in. Returned: success Sample: |
|
A dictionary that enables the application to pass information about functions that the Networking API provides. Returned: success Sample: |
|
The VIF type for the port. Returned: success Sample: |
|
The virtual network interface card (vNIC) type that is bound to the neutron port. Returned: success Sample: |
|
The UUID of the device that uses this port. Returned: success Sample: |
|
The UUID of the entity that uses this port. Returned: success Sample: |
|
DNS assignment information. Returned: success |
|
DNS name Returned: success Sample: |
|
A set of zero or more extra DHCP option pairs. An option pair consists of an option value and name. Returned: success Sample: |
|
The IP addresses for the port. Includes the IP address and UUID of the subnet. Returned: success |
|
The UUID of the port. Returned: success Sample: |
|
The IP address. Returned: success Sample: |
|
The MAC address. Returned: success Sample: |
|
The port name. Returned: success Sample: |
|
The UUID of the attached network. Returned: success Sample: |
|
The port security status. The status is enabled (true) or disabled (false). Returned: success Sample: |
|
The UUIDs of any attached security groups. Returned: success |
|
The port status. Returned: success Sample: |
|
The UUID of the tenant who owns the network. Returned: success Sample: |