os_port_facts – Retrieve facts about ports within OpenStack

From Get docs
Ansible/docs/2.8/modules/os port facts module


os_port_facts – Retrieve facts about ports within OpenStack

New in version 2.1.


Synopsis

  • Retrieve facts about ports from OpenStack.

Requirements

The below requirements are needed on the host that executes this module.

  • openstacksdk
  • python >= 2.7

Parameters

Parameter Choices/Defaults Comments

api_timeout

integer

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

dictionary

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, os_user_domain_name or os_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.

auth_type

string

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

-

Ignored. Present for backwards compatibility

ca_cert

string

A path to a CA Cert bundle that can be used as part of verifying SSL API requests.


aliases: cacert

client_cert

string

A path to a client certificate to use as part of the SSL transaction.


aliases: cert

client_key

string

A path to a client key to use as part of the SSL transaction.


aliases: key

cloud

raw

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.

filters

-

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.

interface

string

added in 2.3

  • admin
  • internal
  • public

Endpoint URL type to fetch from the service catalog.


aliases: endpoint_type

port

-

Unique name or ID of a port.

region_name

string

Name of the region.

timeout

integer

Default:

180

How long should ansible wait for the requested resource.

validate_certs

boolean

  • no

  • yes

Whether or not SSL API requests should be verified.

Before Ansible 2.3 this defaulted to yes.


aliases: verify

wait

boolean

  • no
  • yes

Should ansible wait until the requested resource is complete.



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 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 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, the following are the fields unique to this module:

Key Returned Description

openstack_ports

complex

always, but can be null

List of port dictionaries. A subset of the dictionary keys listed below may be returned, depending on your cloud provider.


admin_state_up

boolean

success

The administrative state of the router, which is up (true) or down (false).


Sample:

True

allowed_address_pairs

list

success

A set of zero or more allowed address pairs. An address pair consists of an IP address and MAC address.


binding:host_id

string

success

The UUID of the host where the port is allocated.


Sample:

b4bd682d-234a-4091-aa5b-4b025a6a7759

binding:profile

dictionary

success

A dictionary the enables the application running on the host to pass and receive VIF port-specific information to the plug-in.


binding:vif_details

dictionary

success

A dictionary that enables the application to pass information about functions that the Networking API provides.


Sample:

{'port_filter': True}

binding:vif_type

dictionary

success

The VIF type for the port.


Sample:

ovs

binding:vnic_type

string

success

The virtual network interface card (vNIC) type that is bound to the neutron port.


Sample:

normal

device_id

string

success

The UUID of the device that uses this port.


Sample:

b4bd682d-234a-4091-aa5b-4b025a6a7759

device_owner

string

success

The UUID of the entity that uses this port.


Sample:

network:router_interface

dns_assignment

list

success

DNS assignment information.


dns_name

string

success

DNS name


extra_dhcp_opts

list

success

A set of zero or more extra DHCP option pairs. An option pair consists of an option value and name.


fixed_ips

list

success

The IP addresses for the port. Includes the IP address and UUID of the subnet.


id

string

success

The UUID of the port.


Sample:

3ec25c97-7052-4ab8-a8ba-92faf84148de

ip_address

string

success

The IP address.


Sample:

127.0.0.1

mac_address

string

success

The MAC address.


Sample:

00:00:5E:00:53:42

name

string

success

The port name.


Sample:

port_name

network_id

string

success

The UUID of the attached network.


Sample:

dd1ede4f-3952-4131-aab6-3b8902268c7d

port_security_enabled

boolean

success

The port security status. The status is enabled (true) or disabled (false).


security_groups

list

success

The UUIDs of any attached security groups.


status

string

success

The port status.


Sample:

ACTIVE

tenant_id

string

success

The UUID of the tenant who owns the network.


Sample:

51fce036d7984ba6af4f6c849f65ef00




Status

Authors

  • David Shrewsbury (@Shrews)

Hint

If you notice any issues in this documentation you can edit this document to improve it.


© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/os_port_facts_module.html