openstack.cloud.floating_ip_info – Get information about floating ips
Note
This plugin is part of the openstack.cloud collection (version 1.5.1).
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.
To use it in a playbook, specify: openstack.cloud.floating_ip_info.
Synopsis
- Get a generator of floating ips.
Requirements
The below requirements are needed on the host that executes this module.
- openstacksdk
- openstacksdk >= 0.12.0
- python >= 3.6
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, 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.
|
|
| 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
string
|
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.
|
|
| description
string
|
The description of a floating IP.
|
|
| fixed_ip_address
string
|
The fixed IP address associated with a floating IP address.
|
|
| floating_ip_address
string
|
The IP address of a floating IP.
|
|
| floating_network
string
|
The name or id of the network associated with a floating IP.
|
|
| interface
string
|
|
Endpoint URL type to fetch from the service catalog.
aliases: endpoint_type |
| port
string
|
The name or id of the port to which a floating IP is associated.
|
|
| project_id
string
|
The ID of the project a floating IP is associated with.
|
|
| region_name
string
|
Name of the region.
|
|
| router
string
|
The name or id of an associated router.
|
|
| status
string
|
|
The status of a floating IP, which can be ``ACTIVE``or ``DOWN``.
|
| timeout
integer
|
Default:
180
|
How long should ansible wait for the requested resource.
|
| validate_certs
boolean
|
|
Whether or not SSL API requests should be verified.
Before Ansible 2.3 this defaulted to
yes.
aliases: verify |
| wait
boolean
|
|
Should ansible wait until the requested resource is complete.
|
Notes
Note
- The standard OpenStack environment variables, such as
OS_USERNAMEmay 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
# Getting all floating ips
- openstack.cloud.floating_ip_info:
register: fips
# Getting fip by associated fixed IP address.
- openstack.cloud.floating_ip_info:
fixed_ip_address: 192.168.10.8
register: fip
# Getting fip by associated router.
- openstack.cloud.floating_ip_info:
router: my-router
register: fip
Return Values
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description | |
|---|---|---|---|
| floating_ips
complex
|
On Success. |
The floating ip objects list.
|
|
| created_at
string
|
success |
Timestamp at which the floating IP was assigned.
|
|
| description
string
|
success |
The description of a floating IP.
|
|
| dns_domain
string
|
success |
The DNS domain.
|
|
| dns_name
string
|
success |
The DNS name.
|
|
| fixed_ip_address
string
|
success |
The fixed IP address associated with a floating IP address.
|
|
| floating_ip_address
string
|
success |
The IP address of a floating IP.
|
|
| floating_network_id
string
|
success |
The id of the network associated with a floating IP.
|
|
| id
string
|
success |
Id of the floating ip.
|
|
| name
string
|
success |
Name of the floating ip.
|
|
| port_details
string
|
success |
The details of the port that this floating IP associates with. Present if ``fip-port-details`` extension is loaded.
|
|
| port_id
string
|
success |
The port ID floating ip associated with.
|
|
| project_id
string
|
success |
The ID of the project this floating IP is associated with.
|
|
| qos_policy_id
string
|
success |
The ID of the QoS policy attached to the floating IP.
|
|
| revision_number
string
|
success |
Revision number.
|
|
| router_id
string
|
success |
The id of the router floating ip associated with.
|
|
| status
string
|
success |
The status of a floating IP, which can be ``ACTIVE``or ``DOWN``. Can be 'ACTIVE' and 'DOWN'.
|
|
| subnet_id
string
|
success |
The id of the subnet the floating ip associated with.
|
|
| tags
string
|
success |
List of tags.
|
|
| updated_at
string
|
success |
Timestamp at which the floating IP was last updated.
|
|
Authors
- OpenStack Ansible SIG
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/openstack/cloud/floating_ip_info_module.html