Documentation

os_port_facts - Retrieve facts about ports within OpenStack.

New in version 2.1.

Synopsis

  • Retrieve facts about ports from OpenStack.

Requirements (on host that executes module)

  • python >= 2.6
  • python >= 2.7
  • shade

Options

parameter required default choices comments
api_timeout
no None
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.
auth
no
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 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.
auth_type
no password
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.
availability_zone
no
Ignored. Present for backwards compatability
cacert
no None
A path to a CA Cert bundle that can be used as part of verifying SSL API requests.
cert
no None
A path to a client certificate to use as part of the SSL transaction.
cloud
no
Named cloud to operate against. 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.
endpoint_type
no public
  • public
  • internal
  • admin
Endpoint URL type to fetch from the service catalog.
filters
no
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.
key
no None
A path to a client key to use as part of the SSL transaction.
port
no
Unique name or ID of a port.
region_name
no
Name of the region.
timeout
no 180
How long should ansible wait for the requested resource.
validate_certs
no
Whether or not SSL API requests should be verified. Before 2.3 this defaulted to True.

aliases: verify
wait
no yes
  • yes
  • no
Should ansible wait until the requested resource is complete.

Examples

# Gather facts about all ports
- os_port_facts:
    cloud: mycloud

# Gather facts about a single port
- os_port_facts:
    cloud: mycloud
    port: 6140317d-e676-31e1-8a4a-b1913814a471

# Gather facts about all ports that have device_id set to a specific value
# and with a status of ACTIVE.
- os_port_facts:
    cloud: mycloud
    filters:
      device_id: 1038a010-3a37-4a9d-82ea-652f1da36597
      status: ACTIVE

Return Values

Common return values are documented here Return Values, the following are the fields unique to this module:

name description returned type sample
openstack_ports List of port dictionaries. A subset of the dictionary keys listed below may be returned, depending on your cloud provider. always, but can be null complex
contains:
name description returned type sample
status The port status. success string ACTIVE
dns_name DNS name success string
binding:host_id The UUID of the host where the port is allocated. success string b4bd682d-234a-4091-aa5b-4b025a6a7759
allowed_address_pairs A set of zero or more allowed address pairs. An address pair consists of an IP address and MAC address. success list []
extra_dhcp_opts A set of zero or more extra DHCP option pairs. An option pair consists of an option value and name. success list []
dns_assignment DNS assignment information. success list
device_owner The UUID of the entity that uses this port. success string network:router_interface
port_security_enabled The port security status. The status is enabled (true) or disabled (false). success boolean False
binding:profile A dictionary the enables the application running on the host to pass and receive VIF port-specific information to the plug-in. success dict {}
fixed_ips The IP addresses for the port. Includes the IP address and UUID of the subnet. success list
id The UUID of the port. success string 3ec25c97-7052-4ab8-a8ba-92faf84148de
security_groups The UUIDs of any attached security groups. success list
device_id The UUID of the device that uses this port. success string b4bd682d-234a-4091-aa5b-4b025a6a7759
name The port name. success string port_name
admin_state_up The administrative state of the router, which is up (true) or down (false). success boolean True
network_id The UUID of the attached network. success string dd1ede4f-3952-4131-aab6-3b8902268c7d
ip_address The IP address. success string 127.0.0.1
binding:vif_details A dictionary that enables the application to pass information about functions that the Networking API provides. success dict {'port_filter': True}
binding:vnic_type The virtual network interface card (vNIC) type that is bound to the neutron port. success string normal
binding:vif_type The VIF type for the port. success dict ovs
tenant_id The UUID of the tenant who owns the network. success string 51fce036d7984ba6af4f6c849f65ef00
mac_address The MAC address. success string 00:00:5E:00:53:42


Notes

Note

  • Facts are placed in the openstack_ports variable.
  • The standard OpenStack environment variables, such as OS_USERNAME may be used instead of providing explicit values.
  • Auth information is driven by os-client-config, 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 http://docs.openstack.org/developer/os-client-config

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Support

This module is community maintained without core committer oversight.

For more information on what this means please read Module Support

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.