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 compatibility
|
||
| 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 |
|
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 |
|
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: |
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Notes
Note
- Facts are placed in the
openstack_portsvariable. - The standard OpenStack environment variables, such as
OS_USERNAMEmay 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.
For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/os_port_facts_module.html
